HdBe-Payer
Profile | Description | Status | URL |
---|---|---|---|
HdBe-Payer.InsuranceCompany | Payers are organizations or individuals that pay for the healthcare supplied to the patient. This profile represents insurance organizations with direct financial responsibility to the patient. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-Payer.InsuranceCompany |
HdBe-Payer.PayerPerson | Payers are organizations or individuals that pay for the healthcare supplied to the patient. This profile represents a payer as a natural person or a juridical person, such as an organization, municipality, etc. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-Payer.PayerPerson |
HdBe-Payer-Organization | The Payer profiles can refer to respectively an Organization as PayerPerson or an InsuranceCompany. This profile can thus represent either the PayerName or InsuranceCompany concept and both the AddressInformation and ContactInformation concepts of the CBB Payer. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-Payer-Organization |
Overview |
---|
The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These two containers cannot be profiled within one profile because they both require mapping different concepts on elements such as The CBB container Payer.InsuranceCompany is mapped to this Coverage profile and uses the profile HdBe-Payer-Organization to capture the OrganizationName, IdentificationNumber, AddressInformation and ContactInformation. The HdBe-Payer-Organization profile is referenced using the |
HdBe-Payer.InsuranceCompany
Coverage | I | Coverage | Element idCoverage Payer / Insurance Alternate namesBetaler, Verzekering DefinitionFinancial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These two containers cannot be profiled within one profile because they both require mapping different concepts on elements such as The CBB container Payer.InsuranceCompany is mapped to this Coverage profile and uses the profile HdBe-Payer-Organization to capture the OrganizationName, IdentificationNumber, AddressInformation and ContactInformation. The HdBe-Payer-Organization profile is referenced using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCoverage.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCoverage.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCoverage.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idCoverage.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idCoverage.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCoverage.identifier Business Identifier for the coverage DefinitionA unique identifier assigned to this coverage. Allows coverages to be distinguished and referenced. The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.
|
status | Σ ?! | 1..1 | codeBinding | Element idCoverage.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. Sending systems that don't record an explicit status can use the following guidance to infer a value from the CBB:
A code specifying the state of the resource instance.
|
type | Σ | 0..1 | CodeableConceptBinding | Element idCoverage.type InsuranceType Alternate namesVerzekeringssoort DefinitionType of insurance policy. Codes as returned in the Check for Right to Insurance. The order of application of coverages is dependent on the types of coverage. 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. The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
|
policyHolder | Σ I | 0..1 | Reference(Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idCoverage.policyHolder Owner of the policy DefinitionThe party who 'owns' the insurance policy. This provides employer information in the case of Worker's Compensation and other policies. For example: may be an individual, corporation or the subscriber's employer. Reference(Patient | RelatedPerson | Organization) Constraints
|
subscriber | Σ I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idCoverage.subscriber Subscriber to the policy DefinitionThe party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. This is the party who is entitled to the benfits under the policy. May be self or a parent in the case of dependants. Reference(Patient | RelatedPerson) Constraints
|
subscriberId | Σ | 0..1 | string | Element idCoverage.subscriberId InsurantNumber Alternate namesVerzekerdeNummer DefinitionNumber under which the insured person is registered at the insurance company This item maps the ‘Identification number of the card’ on EHIC field 8 The insurer requires this identifier on correspondance and claims (digital and otherwise). Note that FHIR strings SHALL NOT exceed 1MB in size
|
beneficiary | Σ I | 1..1 | Reference(Patient | HdBe-Patient) | Element idCoverage.beneficiary Plan beneficiary DefinitionThe party who benefits from the insurance coverage; the patient when products and/or services are provided. This is the party who receives treatment for which the costs are reimbursed under the coverage. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | HdBe-Patient) Constraints
|
dependent | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.dependent Dependent number DefinitionA unique identifier for a dependent under the coverage. For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary. Periodically the member number is constructed from the subscriberId and the dependant number.
|
relationship | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.relationship Beneficiary relationship to the subscriber DefinitionThe relationship of beneficiary (patient) to the subscriber. To determine relationship between the patient and the subscriber to determine coordination of benefits. Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others. The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
| |
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.period Coverage start and end dates DefinitionTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force. Some insurers require the submission of the coverage term. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.period.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.period.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
start | Σ I | 0..1 | dateTime | Element idCoverage.period.start StartDateTime Alternate namesBeginDatumTijd DefinitionDate from which the insurance policy coverage applies. If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | Element idCoverage.period.end EndDateTime Alternate namesEindDatumTijd DefinitionDate until which the insurance policy coverage applies. This item maps the ‘Expiry date’ on EHIC field 9. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing
|
payor | Σ I | 1..1 | Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization) | Element idCoverage.payor InsuranceCompany Alternate namesVerzekeraar DefinitionThe program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. Need to identify the issuer to target for claim processing and for coordination of benefit processing. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations. Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization) Constraints
|
class | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.class Additional coverage classifications DefinitionA suite of underwriter specific classifiers. The codes provided on the health card which identify or confirm the specific policy for the insurer. For example may be used to identify a class of coverage or employer group, Policy, Plan.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.class.type Type of class such as 'group' or 'plan' DefinitionThe type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan. The insurer issued label for a specific health card value. 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. The policy classifications, eg. Group, Plan, Class, etc.
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCoverage.class.value Value associated with the type DefinitionThe alphanumeric string value associated with the insurer issued label. The insurer issued label and value are necessary to identify the specific policy. For example, the Group or Plan number.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.name Human readable description of the type and value DefinitionA short description for the class. Used to provide a meaningful description in correspondence to the patient. Note that FHIR strings SHALL NOT exceed 1MB in size
|
order | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idCoverage.order Relative order of the coverage DefinitionThe order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care. Used in managing the coordination of benefits. 32 bit number; for values larger than this, use decimal
|
network | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.network Insurer network DefinitionThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply. Used in referral for treatment and in claims processing. Note that FHIR strings SHALL NOT exceed 1MB in size
|
costToBeneficiary | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary Patient payments for services/products Alternate namesCoPay, Deductible, Exceptions DefinitionA suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card. Required by providers to manage financial transaction with the patient. For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.type Cost category DefinitionThe category of patient centric costs associated with treatment. Needed to identify the category associated with the amount for the patient. For example visit, specialist visits, emergency, inpatient care, etc. The types of services to which patient copayments are specified.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.value[x] The amount or percentage due from the beneficiary DefinitionThe amount due from the patient for the cost category. Needed to identify the amount for the patient associated with the category. Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
| |
valueQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
exception | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception Exceptions for patient payments DefinitionA suite of codes indicating exceptions or reductions to patient costs and their effective periods. Required by providers to manage financial transaction with the patient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.type Exception category DefinitionThe code for the specific exception. Needed to identify the exception associated with the amount for the patient. 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. The types of exceptions from the part or full value of financial obligations such as copays.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.period The effective period of the exception DefinitionThe timeframe during when the exception is in force. Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
subrogation | 0..1 | boolean | There are no (further) constraints on this element Element idCoverage.subrogation Reimbursement to insurer DefinitionWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. See definition for when to be used. Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
| |
contract | I | 0..* | Reference(Contract) | There are no (further) constraints on this element Element idCoverage.contract Contract details DefinitionThe policy(s) which constitute this insurance coverage. To reference the legally binding contract between the policy holder and the insurer. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Coverage | I | Coverage | Element idCoverage Payer / Insurance Alternate namesBetaler, Verzekering DefinitionFinancial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These two containers cannot be profiled within one profile because they both require mapping different concepts on elements such as The CBB container Payer.InsuranceCompany is mapped to this Coverage profile and uses the profile HdBe-Payer-Organization to capture the OrganizationName, IdentificationNumber, AddressInformation and ContactInformation. The HdBe-Payer-Organization profile is referenced using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCoverage.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCoverage.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCoverage.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idCoverage.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idCoverage.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCoverage.identifier Business Identifier for the coverage DefinitionA unique identifier assigned to this coverage. Allows coverages to be distinguished and referenced. The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.
|
status | Σ ?! | 1..1 | codeBinding | Element idCoverage.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. Sending systems that don't record an explicit status can use the following guidance to infer a value from the CBB:
A code specifying the state of the resource instance.
|
type | Σ | 0..1 | CodeableConceptBinding | Element idCoverage.type InsuranceType Alternate namesVerzekeringssoort DefinitionType of insurance policy. Codes as returned in the Check for Right to Insurance. The order of application of coverages is dependent on the types of coverage. 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. The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
|
policyHolder | Σ I | 0..1 | Reference(Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idCoverage.policyHolder Owner of the policy DefinitionThe party who 'owns' the insurance policy. This provides employer information in the case of Worker's Compensation and other policies. For example: may be an individual, corporation or the subscriber's employer. Reference(Patient | RelatedPerson | Organization) Constraints
|
subscriber | Σ I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idCoverage.subscriber Subscriber to the policy DefinitionThe party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. This is the party who is entitled to the benfits under the policy. May be self or a parent in the case of dependants. Reference(Patient | RelatedPerson) Constraints
|
subscriberId | Σ | 0..1 | string | Element idCoverage.subscriberId InsurantNumber Alternate namesVerzekerdeNummer DefinitionNumber under which the insured person is registered at the insurance company This item maps the ‘Identification number of the card’ on EHIC field 8 The insurer requires this identifier on correspondance and claims (digital and otherwise). Note that FHIR strings SHALL NOT exceed 1MB in size
|
beneficiary | Σ I | 1..1 | Reference(Patient | HdBe-Patient) | Element idCoverage.beneficiary Plan beneficiary DefinitionThe party who benefits from the insurance coverage; the patient when products and/or services are provided. This is the party who receives treatment for which the costs are reimbursed under the coverage. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | HdBe-Patient) Constraints
|
dependent | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.dependent Dependent number DefinitionA unique identifier for a dependent under the coverage. For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary. Periodically the member number is constructed from the subscriberId and the dependant number.
|
relationship | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.relationship Beneficiary relationship to the subscriber DefinitionThe relationship of beneficiary (patient) to the subscriber. To determine relationship between the patient and the subscriber to determine coordination of benefits. Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others. The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
| |
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.period Coverage start and end dates DefinitionTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force. Some insurers require the submission of the coverage term. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.period.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.period.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
start | Σ I | 0..1 | dateTime | Element idCoverage.period.start StartDateTime Alternate namesBeginDatumTijd DefinitionDate from which the insurance policy coverage applies. If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | Element idCoverage.period.end EndDateTime Alternate namesEindDatumTijd DefinitionDate until which the insurance policy coverage applies. This item maps the ‘Expiry date’ on EHIC field 9. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing
|
payor | Σ I | 1..1 | Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization) | Element idCoverage.payor InsuranceCompany Alternate namesVerzekeraar DefinitionThe program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. Need to identify the issuer to target for claim processing and for coordination of benefit processing. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations. Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization) Constraints
|
class | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.class Additional coverage classifications DefinitionA suite of underwriter specific classifiers. The codes provided on the health card which identify or confirm the specific policy for the insurer. For example may be used to identify a class of coverage or employer group, Policy, Plan.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.class.type Type of class such as 'group' or 'plan' DefinitionThe type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan. The insurer issued label for a specific health card value. 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. The policy classifications, eg. Group, Plan, Class, etc.
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCoverage.class.value Value associated with the type DefinitionThe alphanumeric string value associated with the insurer issued label. The insurer issued label and value are necessary to identify the specific policy. For example, the Group or Plan number.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.name Human readable description of the type and value DefinitionA short description for the class. Used to provide a meaningful description in correspondence to the patient. Note that FHIR strings SHALL NOT exceed 1MB in size
|
order | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idCoverage.order Relative order of the coverage DefinitionThe order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care. Used in managing the coordination of benefits. 32 bit number; for values larger than this, use decimal
|
network | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.network Insurer network DefinitionThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply. Used in referral for treatment and in claims processing. Note that FHIR strings SHALL NOT exceed 1MB in size
|
costToBeneficiary | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary Patient payments for services/products Alternate namesCoPay, Deductible, Exceptions DefinitionA suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card. Required by providers to manage financial transaction with the patient. For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.type Cost category DefinitionThe category of patient centric costs associated with treatment. Needed to identify the category associated with the amount for the patient. For example visit, specialist visits, emergency, inpatient care, etc. The types of services to which patient copayments are specified.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.value[x] The amount or percentage due from the beneficiary DefinitionThe amount due from the patient for the cost category. Needed to identify the amount for the patient associated with the category. Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
| |
valueQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
exception | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception Exceptions for patient payments DefinitionA suite of codes indicating exceptions or reductions to patient costs and their effective periods. Required by providers to manage financial transaction with the patient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.type Exception category DefinitionThe code for the specific exception. Needed to identify the exception associated with the amount for the patient. 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. The types of exceptions from the part or full value of financial obligations such as copays.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.period The effective period of the exception DefinitionThe timeframe during when the exception is in force. Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
subrogation | 0..1 | boolean | There are no (further) constraints on this element Element idCoverage.subrogation Reimbursement to insurer DefinitionWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. See definition for when to be used. Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
| |
contract | I | 0..* | Reference(Contract) | There are no (further) constraints on this element Element idCoverage.contract Contract details DefinitionThe policy(s) which constitute this insurance coverage. To reference the legally binding contract between the policy holder and the insurer. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Coverage | I | Coverage | Element idCoverage Payer / Insurance Alternate namesBetaler, Verzekering DefinitionFinancial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These two containers cannot be profiled within one profile because they both require mapping different concepts on elements such as The CBB container Payer.InsuranceCompany is mapped to this Coverage profile and uses the profile HdBe-Payer-Organization to capture the OrganizationName, IdentificationNumber, AddressInformation and ContactInformation. The HdBe-Payer-Organization profile is referenced using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCoverage.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCoverage.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCoverage.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idCoverage.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idCoverage.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCoverage.identifier Business Identifier for the coverage DefinitionA unique identifier assigned to this coverage. Allows coverages to be distinguished and referenced. The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.
|
status | Σ ?! | 1..1 | codeBinding | Element idCoverage.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. Sending systems that don't record an explicit status can use the following guidance to infer a value from the CBB:
A code specifying the state of the resource instance.
|
type | Σ | 0..1 | CodeableConceptBinding | Element idCoverage.type InsuranceType Alternate namesVerzekeringssoort DefinitionType of insurance policy. Codes as returned in the Check for Right to Insurance. The order of application of coverages is dependent on the types of coverage. 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. The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
|
policyHolder | Σ I | 0..1 | Reference(Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idCoverage.policyHolder Owner of the policy DefinitionThe party who 'owns' the insurance policy. This provides employer information in the case of Worker's Compensation and other policies. For example: may be an individual, corporation or the subscriber's employer. Reference(Patient | RelatedPerson | Organization) Constraints
|
subscriber | Σ I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idCoverage.subscriber Subscriber to the policy DefinitionThe party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. This is the party who is entitled to the benfits under the policy. May be self or a parent in the case of dependants. Reference(Patient | RelatedPerson) Constraints
|
subscriberId | Σ | 0..1 | string | Element idCoverage.subscriberId InsurantNumber Alternate namesVerzekerdeNummer DefinitionNumber under which the insured person is registered at the insurance company This item maps the ‘Identification number of the card’ on EHIC field 8 The insurer requires this identifier on correspondance and claims (digital and otherwise). Note that FHIR strings SHALL NOT exceed 1MB in size
|
beneficiary | Σ I | 1..1 | Reference(Patient | HdBe-Patient) | Element idCoverage.beneficiary Plan beneficiary DefinitionThe party who benefits from the insurance coverage; the patient when products and/or services are provided. This is the party who receives treatment for which the costs are reimbursed under the coverage. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | HdBe-Patient) Constraints
|
dependent | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.dependent Dependent number DefinitionA unique identifier for a dependent under the coverage. For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary. Periodically the member number is constructed from the subscriberId and the dependant number.
|
relationship | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.relationship Beneficiary relationship to the subscriber DefinitionThe relationship of beneficiary (patient) to the subscriber. To determine relationship between the patient and the subscriber to determine coordination of benefits. Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others. The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
| |
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.period Coverage start and end dates DefinitionTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force. Some insurers require the submission of the coverage term. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.period.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.period.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
start | Σ I | 0..1 | dateTime | Element idCoverage.period.start StartDateTime Alternate namesBeginDatumTijd DefinitionDate from which the insurance policy coverage applies. If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | Element idCoverage.period.end EndDateTime Alternate namesEindDatumTijd DefinitionDate until which the insurance policy coverage applies. This item maps the ‘Expiry date’ on EHIC field 9. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing
|
payor | Σ I | 1..1 | Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization) | Element idCoverage.payor InsuranceCompany Alternate namesVerzekeraar DefinitionThe program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. Need to identify the issuer to target for claim processing and for coordination of benefit processing. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations. Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization) Constraints
|
class | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.class Additional coverage classifications DefinitionA suite of underwriter specific classifiers. The codes provided on the health card which identify or confirm the specific policy for the insurer. For example may be used to identify a class of coverage or employer group, Policy, Plan.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.class.type Type of class such as 'group' or 'plan' DefinitionThe type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan. The insurer issued label for a specific health card value. 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. The policy classifications, eg. Group, Plan, Class, etc.
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCoverage.class.value Value associated with the type DefinitionThe alphanumeric string value associated with the insurer issued label. The insurer issued label and value are necessary to identify the specific policy. For example, the Group or Plan number.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.name Human readable description of the type and value DefinitionA short description for the class. Used to provide a meaningful description in correspondence to the patient. Note that FHIR strings SHALL NOT exceed 1MB in size
|
order | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idCoverage.order Relative order of the coverage DefinitionThe order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care. Used in managing the coordination of benefits. 32 bit number; for values larger than this, use decimal
|
network | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.network Insurer network DefinitionThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply. Used in referral for treatment and in claims processing. Note that FHIR strings SHALL NOT exceed 1MB in size
|
costToBeneficiary | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary Patient payments for services/products Alternate namesCoPay, Deductible, Exceptions DefinitionA suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card. Required by providers to manage financial transaction with the patient. For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.type Cost category DefinitionThe category of patient centric costs associated with treatment. Needed to identify the category associated with the amount for the patient. For example visit, specialist visits, emergency, inpatient care, etc. The types of services to which patient copayments are specified.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.value[x] The amount or percentage due from the beneficiary DefinitionThe amount due from the patient for the cost category. Needed to identify the amount for the patient associated with the category. Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
| |
valueQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
exception | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception Exceptions for patient payments DefinitionA suite of codes indicating exceptions or reductions to patient costs and their effective periods. Required by providers to manage financial transaction with the patient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.type Exception category DefinitionThe code for the specific exception. Needed to identify the exception associated with the amount for the patient. 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. The types of exceptions from the part or full value of financial obligations such as copays.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.period The effective period of the exception DefinitionThe timeframe during when the exception is in force. Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
subrogation | 0..1 | boolean | There are no (further) constraints on this element Element idCoverage.subrogation Reimbursement to insurer DefinitionWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. See definition for when to be used. Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
| |
contract | I | 0..* | Reference(Contract) | There are no (further) constraints on this element Element idCoverage.contract Contract details DefinitionThe policy(s) which constitute this insurance coverage. To reference the legally binding contract between the policy holder and the insurer. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Mapping FHIR profile to CBB
Path | map | CBB | comment |
---|---|---|---|
Coverage | Payer | HdBe-Payer | |
Coverage | Insurance | HdBe-Payer | |
Coverage.status | Payer.InsuranceCompany.Insurance.StartDateTime | HdBe-Payer | StartDateTime (implicit, main mapping is on Coverage.period.start) |
Coverage.status | Payer.InsuranceCompany.Insurance.EndDateTime | HdBe-Payer | EndDateTime (implicit, main mapping is on Coverage.period.end) |
Coverage.type | Payer.InsuranceCompany.Insurance.InsuranceType | HdBe-Payer | |
Coverage.subscriberId | Payer.InsuranceCompany.InsurantNumber | HdBe-Payer | |
Coverage.period.start | Payer.InsuranceCompany.Insurance.StartDateTime | HdBe-Payer | |
Coverage.period.end | Payer.InsuranceCompany.Insurance.EndDateTime | HdBe-Payer | |
Coverage.payor | Payer.InsuranceCompany | HdBe-Payer |
zib-Payer.InsuranceCompany difference
Concept | Category | Description |
---|---|---|
description | textual | Made the profile more specific to the profile instead of the copied zib description for a better rendering in the IG. |
HdBe-Payer.PayerPerson
Coverage | I | Coverage | Element idCoverage Payer Alternate namesBetaler DefinitionFinancial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These two containers cannot be profiled within one profile because they both require mapping different concepts on elements such as The CBB container Payer.PayerPerson is mapped to this Coverage profile and uses the profiles HdBe-Patient, HdBe-ContactPerson and HdBe-Payer-Organization to capture the PayerName, AddressInformation and ContactInformation. These profiles are referenced using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCoverage.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCoverage.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCoverage.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idCoverage.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idCoverage.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
bankInformation | I | 0..* | Extension(Complex) | Element idCoverage.extension:bankInformation BankInformation Alternate namesextensions, user content, Bankgegevens DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttps://fhir.healthdata.be/StructureDefinition/ext-Payer.BankInformation Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
bankName | I | 0..1 | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. bankName
| |
value[x] | 0..1 | Element idCoverage.extension:bankInformation.extension:bankName.value[x] BankName Alternate namesBankNaam DefinitionName of the financial organization.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
bankCode | I | 0..1 | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. bankCode
| |
value[x] | 0..1 | Element idCoverage.extension:bankInformation.extension:bankCode.value[x] BankCode Alternate namesBankcode DefinitionCode indicating the bank and branch. For European countries, this is the organization’s BIC or SWIFT code.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
accountNumber | I | 0..1 | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. accountNumber
| |
value[x] | 0..1 | Element idCoverage.extension:bankInformation.extension:accountNumber.value[x] AccountNumber Alternate namesRekeningnummer DefinitionThe payer’s bank account number at the listed organization. For European countries, this is the IBAN.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.healthdata.be/StructureDefinition/ext-Payer.BankInformation
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCoverage.identifier Business Identifier for the coverage DefinitionA unique identifier assigned to this coverage. Allows coverages to be distinguished and referenced. The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.
|
status | Σ ?! | 1..1 | codeBinding | Element idCoverage.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. When systems don't record an explicit status and no status can be derived from the A code specifying the state of the resource instance.
|
type | Σ | 1..1 | CodeableConceptBindingPattern | Element idCoverage.type Coverage category such as medical or accident DefinitionThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. The order of application of coverages is dependent on the types of coverage. 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. The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/coverage-selfpay", "code": "pay" } ] }
|
policyHolder | Σ I | 0..1 | Reference(Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idCoverage.policyHolder Owner of the policy DefinitionThe party who 'owns' the insurance policy. This provides employer information in the case of Worker's Compensation and other policies. For example: may be an individual, corporation or the subscriber's employer. Reference(Patient | RelatedPerson | Organization) Constraints
|
subscriber | Σ I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idCoverage.subscriber Subscriber to the policy DefinitionThe party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. This is the party who is entitled to the benfits under the policy. May be self or a parent in the case of dependants. Reference(Patient | RelatedPerson) Constraints
|
subscriberId | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.subscriberId ID assigned to the subscriber DefinitionThe insurer assigned ID for the Subscriber. The insurer requires this identifier on correspondance and claims (digital and otherwise). Note that FHIR strings SHALL NOT exceed 1MB in size
|
beneficiary | Σ I | 1..1 | Reference(Patient | HdBe-Patient) | Element idCoverage.beneficiary Plan beneficiary DefinitionThe party who benefits from the insurance coverage; the patient when products and/or services are provided. This is the party who receives treatment for which the costs are reimbursed under the coverage. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | HdBe-Patient) Constraints
|
dependent | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.dependent Dependent number DefinitionA unique identifier for a dependent under the coverage. For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary. Periodically the member number is constructed from the subscriberId and the dependant number.
|
relationship | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.relationship Beneficiary relationship to the subscriber DefinitionThe relationship of beneficiary (patient) to the subscriber. To determine relationship between the patient and the subscriber to determine coordination of benefits. Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others. The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
| |
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.period Coverage start and end dates DefinitionTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force. Some insurers require the submission of the coverage term. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
payor | Σ I | 1..1 | Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization | HdBe-Patient | HdBe-ContactPerson) | Element idCoverage.payor PayerPerson Alternate namesBetalerPersoon DefinitionIn the PayerPerson concept a person is a natural person or a juridical person, such as an organization, municipality, etc. Need to identify the issuer to target for claim processing and for coordination of benefit processing. If the resource referenced is conformant to one of the target CBB profiles, these profiles provide a mapping to the relevant CBB Payer concepts. If it is not conformant to one of these CBB profiles, it SHALL have at least the following FHIR elements filled to be compliant with the subsequent CBB Payer concepts:
Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization | HdBe-Patient | HdBe-ContactPerson) Constraints
|
class | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.class Additional coverage classifications DefinitionA suite of underwriter specific classifiers. The codes provided on the health card which identify or confirm the specific policy for the insurer. For example may be used to identify a class of coverage or employer group, Policy, Plan.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.class.type Type of class such as 'group' or 'plan' DefinitionThe type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan. The insurer issued label for a specific health card value. 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. The policy classifications, eg. Group, Plan, Class, etc.
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCoverage.class.value Value associated with the type DefinitionThe alphanumeric string value associated with the insurer issued label. The insurer issued label and value are necessary to identify the specific policy. For example, the Group or Plan number.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.name Human readable description of the type and value DefinitionA short description for the class. Used to provide a meaningful description in correspondence to the patient. Note that FHIR strings SHALL NOT exceed 1MB in size
|
order | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idCoverage.order Relative order of the coverage DefinitionThe order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care. Used in managing the coordination of benefits. 32 bit number; for values larger than this, use decimal
|
network | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.network Insurer network DefinitionThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply. Used in referral for treatment and in claims processing. Note that FHIR strings SHALL NOT exceed 1MB in size
|
costToBeneficiary | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary Patient payments for services/products Alternate namesCoPay, Deductible, Exceptions DefinitionA suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card. Required by providers to manage financial transaction with the patient. For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.type Cost category DefinitionThe category of patient centric costs associated with treatment. Needed to identify the category associated with the amount for the patient. For example visit, specialist visits, emergency, inpatient care, etc. The types of services to which patient copayments are specified.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.value[x] The amount or percentage due from the beneficiary DefinitionThe amount due from the patient for the cost category. Needed to identify the amount for the patient associated with the category. Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
| |
valueQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
exception | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception Exceptions for patient payments DefinitionA suite of codes indicating exceptions or reductions to patient costs and their effective periods. Required by providers to manage financial transaction with the patient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.type Exception category DefinitionThe code for the specific exception. Needed to identify the exception associated with the amount for the patient. 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. The types of exceptions from the part or full value of financial obligations such as copays.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.period The effective period of the exception DefinitionThe timeframe during when the exception is in force. Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
subrogation | 0..1 | boolean | There are no (further) constraints on this element Element idCoverage.subrogation Reimbursement to insurer DefinitionWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. See definition for when to be used. Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
| |
contract | I | 0..* | Reference(Contract) | There are no (further) constraints on this element Element idCoverage.contract Contract details DefinitionThe policy(s) which constitute this insurance coverage. To reference the legally binding contract between the policy holder and the insurer. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Coverage | I | Coverage | Element idCoverage Payer Alternate namesBetaler DefinitionFinancial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These two containers cannot be profiled within one profile because they both require mapping different concepts on elements such as The CBB container Payer.PayerPerson is mapped to this Coverage profile and uses the profiles HdBe-Patient, HdBe-ContactPerson and HdBe-Payer-Organization to capture the PayerName, AddressInformation and ContactInformation. These profiles are referenced using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCoverage.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCoverage.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCoverage.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idCoverage.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idCoverage.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
bankInformation | I | 0..* | Extension(Complex) | Element idCoverage.extension:bankInformation BankInformation Alternate namesextensions, user content, Bankgegevens DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttps://fhir.healthdata.be/StructureDefinition/ext-Payer.BankInformation Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
bankName | I | 0..1 | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. bankName
| |
value[x] | 0..1 | Element idCoverage.extension:bankInformation.extension:bankName.value[x] BankName Alternate namesBankNaam DefinitionName of the financial organization.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
bankCode | I | 0..1 | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. bankCode
| |
value[x] | 0..1 | Element idCoverage.extension:bankInformation.extension:bankCode.value[x] BankCode Alternate namesBankcode DefinitionCode indicating the bank and branch. For European countries, this is the organization’s BIC or SWIFT code.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
accountNumber | I | 0..1 | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. accountNumber
| |
value[x] | 0..1 | Element idCoverage.extension:bankInformation.extension:accountNumber.value[x] AccountNumber Alternate namesRekeningnummer DefinitionThe payer’s bank account number at the listed organization. For European countries, this is the IBAN.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.healthdata.be/StructureDefinition/ext-Payer.BankInformation
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCoverage.identifier Business Identifier for the coverage DefinitionA unique identifier assigned to this coverage. Allows coverages to be distinguished and referenced. The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.
|
status | Σ ?! | 1..1 | codeBinding | Element idCoverage.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. When systems don't record an explicit status and no status can be derived from the A code specifying the state of the resource instance.
|
type | Σ | 1..1 | CodeableConceptBindingPattern | Element idCoverage.type Coverage category such as medical or accident DefinitionThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. The order of application of coverages is dependent on the types of coverage. 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. The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/coverage-selfpay", "code": "pay" } ] }
|
policyHolder | Σ I | 0..1 | Reference(Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idCoverage.policyHolder Owner of the policy DefinitionThe party who 'owns' the insurance policy. This provides employer information in the case of Worker's Compensation and other policies. For example: may be an individual, corporation or the subscriber's employer. Reference(Patient | RelatedPerson | Organization) Constraints
|
subscriber | Σ I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idCoverage.subscriber Subscriber to the policy DefinitionThe party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. This is the party who is entitled to the benfits under the policy. May be self or a parent in the case of dependants. Reference(Patient | RelatedPerson) Constraints
|
subscriberId | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.subscriberId ID assigned to the subscriber DefinitionThe insurer assigned ID for the Subscriber. The insurer requires this identifier on correspondance and claims (digital and otherwise). Note that FHIR strings SHALL NOT exceed 1MB in size
|
beneficiary | Σ I | 1..1 | Reference(Patient | HdBe-Patient) | Element idCoverage.beneficiary Plan beneficiary DefinitionThe party who benefits from the insurance coverage; the patient when products and/or services are provided. This is the party who receives treatment for which the costs are reimbursed under the coverage. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | HdBe-Patient) Constraints
|
dependent | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.dependent Dependent number DefinitionA unique identifier for a dependent under the coverage. For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary. Periodically the member number is constructed from the subscriberId and the dependant number.
|
relationship | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.relationship Beneficiary relationship to the subscriber DefinitionThe relationship of beneficiary (patient) to the subscriber. To determine relationship between the patient and the subscriber to determine coordination of benefits. Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others. The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
| |
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.period Coverage start and end dates DefinitionTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force. Some insurers require the submission of the coverage term. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
payor | Σ I | 1..1 | Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization | HdBe-Patient | HdBe-ContactPerson) | Element idCoverage.payor PayerPerson Alternate namesBetalerPersoon DefinitionIn the PayerPerson concept a person is a natural person or a juridical person, such as an organization, municipality, etc. Need to identify the issuer to target for claim processing and for coordination of benefit processing. If the resource referenced is conformant to one of the target CBB profiles, these profiles provide a mapping to the relevant CBB Payer concepts. If it is not conformant to one of these CBB profiles, it SHALL have at least the following FHIR elements filled to be compliant with the subsequent CBB Payer concepts:
Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization | HdBe-Patient | HdBe-ContactPerson) Constraints
|
class | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.class Additional coverage classifications DefinitionA suite of underwriter specific classifiers. The codes provided on the health card which identify or confirm the specific policy for the insurer. For example may be used to identify a class of coverage or employer group, Policy, Plan.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.class.type Type of class such as 'group' or 'plan' DefinitionThe type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan. The insurer issued label for a specific health card value. 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. The policy classifications, eg. Group, Plan, Class, etc.
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCoverage.class.value Value associated with the type DefinitionThe alphanumeric string value associated with the insurer issued label. The insurer issued label and value are necessary to identify the specific policy. For example, the Group or Plan number.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.name Human readable description of the type and value DefinitionA short description for the class. Used to provide a meaningful description in correspondence to the patient. Note that FHIR strings SHALL NOT exceed 1MB in size
|
order | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idCoverage.order Relative order of the coverage DefinitionThe order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care. Used in managing the coordination of benefits. 32 bit number; for values larger than this, use decimal
|
network | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.network Insurer network DefinitionThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply. Used in referral for treatment and in claims processing. Note that FHIR strings SHALL NOT exceed 1MB in size
|
costToBeneficiary | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary Patient payments for services/products Alternate namesCoPay, Deductible, Exceptions DefinitionA suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card. Required by providers to manage financial transaction with the patient. For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.type Cost category DefinitionThe category of patient centric costs associated with treatment. Needed to identify the category associated with the amount for the patient. For example visit, specialist visits, emergency, inpatient care, etc. The types of services to which patient copayments are specified.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.value[x] The amount or percentage due from the beneficiary DefinitionThe amount due from the patient for the cost category. Needed to identify the amount for the patient associated with the category. Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
| |
valueQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
exception | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception Exceptions for patient payments DefinitionA suite of codes indicating exceptions or reductions to patient costs and their effective periods. Required by providers to manage financial transaction with the patient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.type Exception category DefinitionThe code for the specific exception. Needed to identify the exception associated with the amount for the patient. 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. The types of exceptions from the part or full value of financial obligations such as copays.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.period The effective period of the exception DefinitionThe timeframe during when the exception is in force. Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
subrogation | 0..1 | boolean | There are no (further) constraints on this element Element idCoverage.subrogation Reimbursement to insurer DefinitionWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. See definition for when to be used. Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
| |
contract | I | 0..* | Reference(Contract) | There are no (further) constraints on this element Element idCoverage.contract Contract details DefinitionThe policy(s) which constitute this insurance coverage. To reference the legally binding contract between the policy holder and the insurer. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Coverage | I | Coverage | Element idCoverage Payer Alternate namesBetaler DefinitionFinancial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These two containers cannot be profiled within one profile because they both require mapping different concepts on elements such as The CBB container Payer.PayerPerson is mapped to this Coverage profile and uses the profiles HdBe-Patient, HdBe-ContactPerson and HdBe-Payer-Organization to capture the PayerName, AddressInformation and ContactInformation. These profiles are referenced using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCoverage.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCoverage.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCoverage.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idCoverage.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idCoverage.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
bankInformation | I | 0..* | Extension(Complex) | Element idCoverage.extension:bankInformation BankInformation Alternate namesextensions, user content, Bankgegevens DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttps://fhir.healthdata.be/StructureDefinition/ext-Payer.BankInformation Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
bankName | I | 0..1 | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. bankName
| |
value[x] | 0..1 | Element idCoverage.extension:bankInformation.extension:bankName.value[x] BankName Alternate namesBankNaam DefinitionName of the financial organization.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
bankCode | I | 0..1 | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:bankCode.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. bankCode
| |
value[x] | 0..1 | Element idCoverage.extension:bankInformation.extension:bankCode.value[x] BankCode Alternate namesBankcode DefinitionCode indicating the bank and branch. For European countries, this is the organization’s BIC or SWIFT code.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
accountNumber | I | 0..1 | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.extension:accountNumber.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. accountNumber
| |
value[x] | 0..1 | Element idCoverage.extension:bankInformation.extension:accountNumber.value[x] AccountNumber Alternate namesRekeningnummer DefinitionThe payer’s bank account number at the listed organization. For European countries, this is the IBAN.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.healthdata.be/StructureDefinition/ext-Payer.BankInformation
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idCoverage.extension:bankInformation.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCoverage.identifier Business Identifier for the coverage DefinitionA unique identifier assigned to this coverage. Allows coverages to be distinguished and referenced. The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.
|
status | Σ ?! | 1..1 | codeBinding | Element idCoverage.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. When systems don't record an explicit status and no status can be derived from the A code specifying the state of the resource instance.
|
type | Σ | 1..1 | CodeableConceptBindingPattern | Element idCoverage.type Coverage category such as medical or accident DefinitionThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. The order of application of coverages is dependent on the types of coverage. 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. The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/coverage-selfpay", "code": "pay" } ] }
|
policyHolder | Σ I | 0..1 | Reference(Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idCoverage.policyHolder Owner of the policy DefinitionThe party who 'owns' the insurance policy. This provides employer information in the case of Worker's Compensation and other policies. For example: may be an individual, corporation or the subscriber's employer. Reference(Patient | RelatedPerson | Organization) Constraints
|
subscriber | Σ I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idCoverage.subscriber Subscriber to the policy DefinitionThe party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. This is the party who is entitled to the benfits under the policy. May be self or a parent in the case of dependants. Reference(Patient | RelatedPerson) Constraints
|
subscriberId | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.subscriberId ID assigned to the subscriber DefinitionThe insurer assigned ID for the Subscriber. The insurer requires this identifier on correspondance and claims (digital and otherwise). Note that FHIR strings SHALL NOT exceed 1MB in size
|
beneficiary | Σ I | 1..1 | Reference(Patient | HdBe-Patient) | Element idCoverage.beneficiary Plan beneficiary DefinitionThe party who benefits from the insurance coverage; the patient when products and/or services are provided. This is the party who receives treatment for which the costs are reimbursed under the coverage. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | HdBe-Patient) Constraints
|
dependent | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.dependent Dependent number DefinitionA unique identifier for a dependent under the coverage. For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary. Periodically the member number is constructed from the subscriberId and the dependant number.
|
relationship | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.relationship Beneficiary relationship to the subscriber DefinitionThe relationship of beneficiary (patient) to the subscriber. To determine relationship between the patient and the subscriber to determine coordination of benefits. Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others. The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
| |
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.period Coverage start and end dates DefinitionTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force. Some insurers require the submission of the coverage term. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
payor | Σ I | 1..1 | Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization | HdBe-Patient | HdBe-ContactPerson) | Element idCoverage.payor PayerPerson Alternate namesBetalerPersoon DefinitionIn the PayerPerson concept a person is a natural person or a juridical person, such as an organization, municipality, etc. Need to identify the issuer to target for claim processing and for coordination of benefit processing. If the resource referenced is conformant to one of the target CBB profiles, these profiles provide a mapping to the relevant CBB Payer concepts. If it is not conformant to one of these CBB profiles, it SHALL have at least the following FHIR elements filled to be compliant with the subsequent CBB Payer concepts:
Reference(Organization | Patient | RelatedPerson | HdBe-Payer Organization | HdBe-Patient | HdBe-ContactPerson) Constraints
|
class | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.class Additional coverage classifications DefinitionA suite of underwriter specific classifiers. The codes provided on the health card which identify or confirm the specific policy for the insurer. For example may be used to identify a class of coverage or employer group, Policy, Plan.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.class.type Type of class such as 'group' or 'plan' DefinitionThe type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan. The insurer issued label for a specific health card value. 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. The policy classifications, eg. Group, Plan, Class, etc.
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCoverage.class.value Value associated with the type DefinitionThe alphanumeric string value associated with the insurer issued label. The insurer issued label and value are necessary to identify the specific policy. For example, the Group or Plan number.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.name Human readable description of the type and value DefinitionA short description for the class. Used to provide a meaningful description in correspondence to the patient. Note that FHIR strings SHALL NOT exceed 1MB in size
|
order | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idCoverage.order Relative order of the coverage DefinitionThe order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care. Used in managing the coordination of benefits. 32 bit number; for values larger than this, use decimal
|
network | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.network Insurer network DefinitionThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply. Used in referral for treatment and in claims processing. Note that FHIR strings SHALL NOT exceed 1MB in size
|
costToBeneficiary | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary Patient payments for services/products Alternate namesCoPay, Deductible, Exceptions DefinitionA suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card. Required by providers to manage financial transaction with the patient. For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.type Cost category DefinitionThe category of patient centric costs associated with treatment. Needed to identify the category associated with the amount for the patient. For example visit, specialist visits, emergency, inpatient care, etc. The types of services to which patient copayments are specified.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.value[x] The amount or percentage due from the beneficiary DefinitionThe amount due from the patient for the cost category. Needed to identify the amount for the patient associated with the category. Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
| |
valueQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
exception | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception Exceptions for patient payments DefinitionA suite of codes indicating exceptions or reductions to patient costs and their effective periods. Required by providers to manage financial transaction with the patient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.type Exception category DefinitionThe code for the specific exception. Needed to identify the exception associated with the amount for the patient. 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. The types of exceptions from the part or full value of financial obligations such as copays.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.period The effective period of the exception DefinitionThe timeframe during when the exception is in force. Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
subrogation | 0..1 | boolean | There are no (further) constraints on this element Element idCoverage.subrogation Reimbursement to insurer DefinitionWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. See definition for when to be used. Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
| |
contract | I | 0..* | Reference(Contract) | There are no (further) constraints on this element Element idCoverage.contract Contract details DefinitionThe policy(s) which constitute this insurance coverage. To reference the legally binding contract between the policy holder and the insurer. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Mapping FHIR profile to CBB
Path | map | CBB |
---|---|---|
Coverage | Payer | HdBe-Payer |
Coverage.extension:bankInformation | Payer.PayerPerson.BankInformation | HdBe-Payer |
Coverage.extension:bankInformation.extension:bankName.value[x] | Payer.PayerPerson.BankInformation.BankName | HdBe-Payer |
Coverage.extension:bankInformation.extension:bankCode.value[x] | Payer.PayerPerson.BankInformation.BankCode | HdBe-Payer |
Coverage.extension:bankInformation.extension:accountNumber.value[x] | Payer.PayerPerson.BankInformation.AccountNumber | HdBe-Payer |
Coverage.payor | Payer.PayerPerson | HdBe-Payer |
zib-Payer.PayerPerson difference
Concept | Category | Description |
---|---|---|
description | textual | Made the profile more specific to the profile instead of the copied zib description for a better rendering in the IG. |
HdBe-Payer.Organization
Organization | I | Organization | Element idOrganization InsuranceCompany Alternate namesVerzekeraar DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These profiles can refer to respectively an Organization as PayerPerson or an InsuranceCompany. This profile can thus represent either the PayerName or InsuranceCompany concept and both the AddressInformation and ContactInformation concepts of the CBB.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ I | 0..* | Identifier | Element idOrganization.identifier Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open, by $this(Value) Constraints
|
be-InsuranceIdentificationNumber | Σ I | 0..1 | IdentifierPattern | Element idOrganization.identifier:be-InsuranceIdentificationNumber IdentificationNumber Alternate namesIdentificatieNummer DefinitionUnique healthcare insurance company identification. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
{ "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/be-insurancenumber" }
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.active Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idOrganization.type Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. Used to categorize the organization.
|
name | Σ I | 0..1 | string | Element idOrganization.name OrganizationName / PayerName Alternate namesOrganisatieNaam, BetalerNaam DefinitionFull, official name of the healthcare insurance company or paying organization. Need to use the name as the label of the organization. If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
|
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.alias A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
| |
telecom | I | 0..* | HdBe-ContactInformation | Element idOrganization.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionThe payer’s telephone number and/or e-mail address. Human contact for the organization. Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.
|
address | I | 0..* | HdBe-AddressInformation | Element idOrganization.address AddressInformation Alternate namesAdresgegevens DefinitionThe payer’s address information. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
|
partOf | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOf The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contact Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purpose The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. 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. The purpose for which you would contact a contact party.
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.name A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecom Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
|
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.address Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpoint Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Organization | I | Organization | Element idOrganization InsuranceCompany Alternate namesVerzekeraar DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These profiles can refer to respectively an Organization as PayerPerson or an InsuranceCompany. This profile can thus represent either the PayerName or InsuranceCompany concept and both the AddressInformation and ContactInformation concepts of the CBB.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ I | 0..* | Identifier | Element idOrganization.identifier Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open, by $this(Value) Constraints
|
be-InsuranceIdentificationNumber | Σ I | 0..1 | IdentifierPattern | Element idOrganization.identifier:be-InsuranceIdentificationNumber IdentificationNumber Alternate namesIdentificatieNummer DefinitionUnique healthcare insurance company identification. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
{ "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/be-insurancenumber" }
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.active Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idOrganization.type Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. Used to categorize the organization.
|
name | Σ I | 0..1 | string | Element idOrganization.name OrganizationName / PayerName Alternate namesOrganisatieNaam, BetalerNaam DefinitionFull, official name of the healthcare insurance company or paying organization. Need to use the name as the label of the organization. If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
|
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.alias A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
| |
telecom | I | 0..* | HdBe-ContactInformation | Element idOrganization.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionThe payer’s telephone number and/or e-mail address. Human contact for the organization. Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.
|
address | I | 0..* | HdBe-AddressInformation | Element idOrganization.address AddressInformation Alternate namesAdresgegevens DefinitionThe payer’s address information. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
|
partOf | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOf The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contact Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purpose The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. 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. The purpose for which you would contact a contact party.
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.name A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecom Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
|
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.address Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpoint Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Organization | I | Organization | Element idOrganization InsuranceCompany Alternate namesVerzekeraar DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. The CBB Payer is split into two focal profiles on Coverage based on the PayerPerson and InsuranceCompany containers. These profiles can refer to respectively an Organization as PayerPerson or an InsuranceCompany. This profile can thus represent either the PayerName or InsuranceCompany concept and both the AddressInformation and ContactInformation concepts of the CBB.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ I | 0..* | Identifier | Element idOrganization.identifier Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open, by $this(Value) Constraints
|
be-InsuranceIdentificationNumber | Σ I | 0..1 | IdentifierPattern | Element idOrganization.identifier:be-InsuranceIdentificationNumber IdentificationNumber Alternate namesIdentificatieNummer DefinitionUnique healthcare insurance company identification. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
{ "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/be-insurancenumber" }
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.active Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idOrganization.type Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. Used to categorize the organization.
|
name | Σ I | 0..1 | string | Element idOrganization.name OrganizationName / PayerName Alternate namesOrganisatieNaam, BetalerNaam DefinitionFull, official name of the healthcare insurance company or paying organization. Need to use the name as the label of the organization. If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
|
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.alias A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
| |
telecom | I | 0..* | HdBe-ContactInformation | Element idOrganization.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionThe payer’s telephone number and/or e-mail address. Human contact for the organization. Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.
|
address | I | 0..* | HdBe-AddressInformation | Element idOrganization.address AddressInformation Alternate namesAdresgegevens DefinitionThe payer’s address information. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
|
partOf | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOf The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contact Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purpose The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. 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. The purpose for which you would contact a contact party.
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.name A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecom Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
|
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.address Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpoint Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Mapping FHIR profile to CBB
Path | map | CBB |
---|---|---|
Organization | Payer.InsuranceCompany | HdBe-Payer |
Organization.identifier:be-InsuranceIdentificationNumber | Payer.InsuranceCompany.IdentificationNumber | HdBe-Payer |
Organization.name | Payer.InsuranceCompany.OrganizationName | HdBe-Payer |
Organization.name | Payer.PayerPerson.PayerName | HdBe-Payer |
Organization.telecom | Payer.ContactInformation | HdBe-Payer |
Organization.address | Payer.AddressInformation | HdBe-Payer |
zib-Payer-Organization difference
Concept | Category | Description |
---|---|---|
description | textual | Made the profile more specific to the profile instead of the copied zib description for a better rendering in the IG. |
identifier |
slicing | Replaced uzovi identifier slice with a slice that describes the BE insurance identification. According to HL7 BE / eHealth this should be based on the BeInsuranceNumberNamingSystem |
name |
textual | Removed Dutch context. |
telecom |
reference | Added reference to HdBe-ContactInformation profile, which replaces the two separate HdBe-ContactInformation profiles. |
telecom |
slicing | Removed slicing as the two HdBe-ContactInformation profiles are replaced with one general HdBe-ContactInformation profile, which makes slicing unnecessary. |
Terminology Bindings
Path | Name | Strength | URL | ConceptMap |
---|---|---|---|---|
Coverage.type | InsuranceType | required | https://fhir.healthdata.be/ValueSet/InsuranceType | No bound ConceptMap |