Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-Payer.InsuranceCompany | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: ZibPayerInsuranceCompany | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
Payers are organizations or individuals that pay for the healthcare supplied to the patient. These organizations or individuals can be: facilities or people who financially guarantee or who are responsible for the patient (such as parents or guardians of minors), organizations with direct financial responsibility, combinations of these or the patient themselves.
This Coverage resource represents the InsuranceCompany concept of the Dutch zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) Payer v3.1.1 (2020).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Coverage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Coverage | 0..* | Coverage | This is an abstract profile. Child profiles: NlcorePayerInsuranceCompany Payer / Insurance | |
  status | 1..1 | code | active | cancelled | draft | entered-in-error | |
| type | 0..1 | CodeableConcept | InsuranceType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 (required) | |
| subscriberId | 0..1 | string | InsurantNumber | |
 period | ||||
 start | 0..1 | dateTime | StartDateTime | |
 end | 0..1 | dateTime | EndDateTime | |
 payor | 1..1 | Reference(Organization | Patient | RelatedPerson | zib Payer Organization) | InsuranceCompany | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Coverage.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coverage | 0..* | Coverage | This is an abstract profile. Child profiles: NlcorePayerInsuranceCompany Payer / Insurance | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
 type | Σ | 0..1 | CodeableConcept | InsuranceType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 (required) |
| subscriberId | Σ | 0..1 | string | InsurantNumber |
| beneficiary | Σ | 1..1 | Reference(Patient) | Plan beneficiary |
| payor | Σ | 1..1 | Reference(Organization | Patient | RelatedPerson | zib Payer Organization) | InsuranceCompany |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Coverage.status | required | FinancialResourceStatusCodes |
| Coverage.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Coverage | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Coverage | 0..* | Coverage | This is an abstract profile. Child profiles: NlcorePayerInsuranceCompany Payer / Insurance | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for the coverage | ||||
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
| type | Σ | 0..1 | CodeableConcept | InsuranceType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 (required) | ||||
| policyHolder | Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
| subscriber | Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
| subscriberId | Σ | 0..1 | string | InsurantNumber | ||||
| beneficiary | Σ | 1..1 | Reference(Patient) | Plan beneficiary | ||||
| dependent | Σ | 0..1 | string | Dependent number | ||||
| relationship | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |||||
| period | Σ | 0..1 | Period | Coverage start and end dates | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | StartDateTime | ||||
| end | ΣC | 0..1 | dateTime | EndDateTime | ||||
| payor | Σ | 1..1 | Reference(Organization | Patient | RelatedPerson | zib Payer Organization) | InsuranceCompany | ||||
| class | 0..* | BackboneElement | Additional coverage classifications | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
| value | Σ | 1..1 | string | Value associated with the type | ||||
| name | Σ | 0..1 | string | Human readable description of the type and value | ||||
| order | Σ | 0..1 | positiveInt | Relative order of the coverage | ||||
| network | Σ | 0..1 | string | Insurer network | ||||
| costToBeneficiary | 0..* | BackboneElement | Patient payments for services/products | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. | ||||
 value[x] | Σ | 1..1 | The amount or percentage due from the beneficiary | |||||
| valueQuantity | Quantity(SimpleQuantity) | |||||||
| valueMoney | Money | |||||||
 exception | 0..* | BackboneElement | Exceptions for patient payments | |||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. | ||||
| period | Σ | 0..1 | Period | The effective period of the exception | ||||
| subrogation | 0..1 | boolean | Reimbursement to insurer | |||||
| contract | 0..* | Reference(Contract) | Contract details | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Coverage.language | preferred | CommonLanguages
| ||||
| Coverage.status | required | FinancialResourceStatusCodes | ||||
| Coverage.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 | ||||
| Coverage.relationship | extensible | SubscriberRelationshipCodes | ||||
| Coverage.class.type | extensible | CoverageClassCodes | ||||
| Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodes | ||||
| Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Coverage | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coverage
Differential View
This structure is derived from Coverage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coverage | 0..* | Coverage | This is an abstract profile. Child profiles: NlcorePayerInsuranceCompany Payer / Insurance | |
| status | 1..1 | code | active | cancelled | draft | entered-in-error | |
| type | 0..1 | CodeableConcept | InsuranceType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 (required) | |
| subscriberId | 0..1 | string | InsurantNumber | |
| period | ||||
| start | 0..1 | dateTime | StartDateTime | |
| end | 0..1 | dateTime | EndDateTime | |
| payor | 1..1 | Reference(Organization | Patient | RelatedPerson | zib Payer Organization) | InsuranceCompany | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Coverage.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coverage | 0..* | Coverage | This is an abstract profile. Child profiles: NlcorePayerInsuranceCompany Payer / Insurance | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| type | Σ | 0..1 | CodeableConcept | InsuranceType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 (required) |
| subscriberId | Σ | 0..1 | string | InsurantNumber |
| beneficiary | Σ | 1..1 | Reference(Patient) | Plan beneficiary |
| payor | Σ | 1..1 | Reference(Organization | Patient | RelatedPerson | zib Payer Organization) | InsuranceCompany |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Coverage.status | required | FinancialResourceStatusCodes |
| Coverage.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Coverage | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Coverage | 0..* | Coverage | This is an abstract profile. Child profiles: NlcorePayerInsuranceCompany Payer / Insurance | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for the coverage | ||||
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
| type | Σ | 0..1 | CodeableConcept | InsuranceType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 (required) | ||||
| policyHolder | Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
| subscriber | Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
| subscriberId | Σ | 0..1 | string | InsurantNumber | ||||
| beneficiary | Σ | 1..1 | Reference(Patient) | Plan beneficiary | ||||
| dependent | Σ | 0..1 | string | Dependent number | ||||
| relationship | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |||||
| period | Σ | 0..1 | Period | Coverage start and end dates | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | StartDateTime | ||||
| end | ΣC | 0..1 | dateTime | EndDateTime | ||||
| payor | Σ | 1..1 | Reference(Organization | Patient | RelatedPerson | zib Payer Organization) | InsuranceCompany | ||||
| class | 0..* | BackboneElement | Additional coverage classifications | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
| value | Σ | 1..1 | string | Value associated with the type | ||||
| name | Σ | 0..1 | string | Human readable description of the type and value | ||||
| order | Σ | 0..1 | positiveInt | Relative order of the coverage | ||||
| network | Σ | 0..1 | string | Insurer network | ||||
| costToBeneficiary | 0..* | BackboneElement | Patient payments for services/products | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. | ||||
| value[x] | Σ | 1..1 | The amount or percentage due from the beneficiary | |||||
| valueQuantity | Quantity(SimpleQuantity) | |||||||
| valueMoney | Money | |||||||
| exception | 0..* | BackboneElement | Exceptions for patient payments | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. | ||||
| period | Σ | 0..1 | Period | The effective period of the exception | ||||
| subrogation | 0..1 | boolean | Reimbursement to insurer | |||||
| contract | 0..* | Reference(Contract) | Contract details | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Coverage.language | preferred | CommonLanguages
| ||||
| Coverage.status | required | FinancialResourceStatusCodes | ||||
| Coverage.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.1.1.1--20200901000000 | ||||
| Coverage.relationship | extensible | SubscriberRelationshipCodes | ||||
| Coverage.class.type | extensible | CoverageClassCodes | ||||
| Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodes | ||||
| Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Coverage | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coverage
Other representations of profile: CSV, Excel, Schematron