DHIN 2025Connectathon FHIR IG
0.1.0 - draft
DHIN 2025Connectathon FHIR IG, published by DHIN. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/2025Connectathon/ and changes regularly. See the Directory of published versions
Official URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-claim-coverage | Version: 0.1.0 | |||
Draft as of 2025-10-02 | Computable Name: NgCoverage |
A profile capturing a patient's insurance coverage details.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Plan beneficiary |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Coverage.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
Coverage.type | Base | preferred | Coverage Type and Self-Pay Codes | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |
![]() ![]() ![]() |
S | 1..1 | code | active | cancelled | draft | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Coverage category such as medical or accident |
![]() ![]() ![]() |
S | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Plan beneficiary |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for the coverage | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | ID assigned to the subscriber | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Plan beneficiary | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Dependent number | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Coverage start and end dates | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Additional coverage classifications | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Value associated with the type | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Human readable description of the type and value | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Relative order of the coverage | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Insurer network | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Patient payments for services/products | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | The amount or percentage due from the beneficiary | |||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Exceptions for patient payments | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | The effective period of the exception | ||||
![]() ![]() ![]() |
0..1 | boolean | Reimbursement to insurer | |||||
![]() ![]() ![]() |
0..* | Reference(Contract) | Contract details | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Coverage.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Coverage.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
Coverage.type | Base | preferred | Coverage Type and Self-Pay Codes | 📍4.0.1 | FHIR Std. |
Coverage.relationship | Base | extensible | SubscriberPolicyholder Relationship Codes | 📍4.0.1 | FHIR Std. |
Coverage.class.type | Base | extensible | Coverage Class Codes | 📍4.0.1 | FHIR Std. |
Coverage.costToBeneficiary.type | Base | extensible | Coverage Copay Type Codes | 📍4.0.1 | FHIR Std. |
Coverage.costToBeneficiary.exception.type | Base | example | Example Coverage Financial Exception Codes | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
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
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Plan beneficiary |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Coverage.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
Coverage.type | Base | preferred | Coverage Type and Self-Pay Codes | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
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()
|
Differential View
This structure is derived from Coverage
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |
![]() ![]() ![]() |
S | 1..1 | code | active | cancelled | draft | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Coverage category such as medical or accident |
![]() ![]() ![]() |
S | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Plan beneficiary |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for the coverage | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | ID assigned to the subscriber | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Plan beneficiary | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Dependent number | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Coverage start and end dates | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Additional coverage classifications | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Value associated with the type | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Human readable description of the type and value | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Relative order of the coverage | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Insurer network | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Patient payments for services/products | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | The amount or percentage due from the beneficiary | |||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Exceptions for patient payments | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | The effective period of the exception | ||||
![]() ![]() ![]() |
0..1 | boolean | Reimbursement to insurer | |||||
![]() ![]() ![]() |
0..* | Reference(Contract) | Contract details | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Coverage.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Coverage.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
Coverage.type | Base | preferred | Coverage Type and Self-Pay Codes | 📍4.0.1 | FHIR Std. |
Coverage.relationship | Base | extensible | SubscriberPolicyholder Relationship Codes | 📍4.0.1 | FHIR Std. |
Coverage.class.type | Base | extensible | Coverage Class Codes | 📍4.0.1 | FHIR Std. |
Coverage.costToBeneficiary.type | Base | extensible | Coverage Copay Type Codes | 📍4.0.1 | FHIR Std. |
Coverage.costToBeneficiary.exception.type | Base | example | Example Coverage Financial Exception Codes | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
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