Kenya eClaims FHIR IG
0.1.0 - ci-build Kenya flag

Kenya eClaims FHIR IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PaymentNotice Profile

Official URL: https://example.com/fhir/StructureDefinition/eclaims-paymentnotice Version: 0.1.0
Draft as of 2025-12-09 Computable Name: eClaimsPaymentNotice

This profile defines constraints on the PaymentNotice resource for use within the Kenya eClaims Implementation Guide. It provides notice of a payment-related event, such as the issuance or receipt of funds for a healthcare claim, supporting financial reconciliation and tracking.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice 0..* PaymentNotice PaymentNotice request
... id Σ 1..1 id A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
... meta Σ 1..1 Meta Metadata about a resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier 1..1 Identifier A unique identifier assigned to this payment notice.
... status ?!Σ 1..1 code The status of the resource instance.
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... created Σ 1..1 dateTime The date when this resource was created.
... provider 1..1 Reference(Organization Profile) The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
... payment Σ 1..1 Reference(PaymentReconciliation) A reference to the payment which is the subject of this notice.
... paymentDate 1..1 date The date when the above payment action occurred.
... payee 1..1 Reference(Organization Profile) The party who will receive or has received payment that is the subject of this notification.
... recipient Σ 1..1 Reference(Organization) The party who is notified of the payment status.
... amount Σ 1..1 Money The amount sent to the payee.
... paymentStatus 1..1 CodeableConcept A code indicating whether payment has been sent or cleared.
Binding: PaymentStatusCodes (example): The payment conveyance status codes.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentNotice.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentNotice.paymentStatus Base example Payment Status Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PaymentNotice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PaymentNotice 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 PaymentNotice 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 PaymentNotice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PaymentNotice 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 PaymentNotice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice 0..* PaymentNotice PaymentNotice request
... id 1..1 id A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
... meta 1..1 Meta Metadata about a resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier 1..1 Identifier A unique identifier assigned to this payment notice.
... created 1..1 dateTime The date when this resource was created.
... provider 1..1 Reference(Organization Profile) The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
... payment 1..1 Reference(PaymentReconciliation) A reference to the payment which is the subject of this notice.
... paymentDate 1..1 date The date when the above payment action occurred.
... payee 1..1 Reference(Organization Profile) The party who will receive or has received payment that is the subject of this notification.
... recipient 1..1 Reference(Organization) The party who is notified of the payment status.
... amount 1..1 Money The amount sent to the payee.
... paymentStatus 1..1 CodeableConcept A code indicating whether payment has been sent or cleared.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice 0..* PaymentNotice PaymentNotice request
... id Σ 1..1 id A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
... meta Σ 1..1 Meta Metadata about a resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 Identifier A unique identifier assigned to this payment notice.
... status ?!Σ 1..1 code The status of the resource instance.
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... request 0..1 Reference(Resource) Request reference
... response 0..1 Reference(Resource) Response reference
... created Σ 1..1 dateTime The date when this resource was created.
... provider 1..1 Reference(Organization Profile) The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
... payment Σ 1..1 Reference(PaymentReconciliation) A reference to the payment which is the subject of this notice.
... paymentDate 1..1 date The date when the above payment action occurred.
... payee 1..1 Reference(Organization Profile) The party who will receive or has received payment that is the subject of this notification.
... recipient Σ 1..1 Reference(Organization) The party who is notified of the payment status.
... amount Σ 1..1 Money The amount sent to the payee.
... paymentStatus 1..1 CodeableConcept A code indicating whether payment has been sent or cleared.
Binding: PaymentStatusCodes (example): The payment conveyance status codes.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentNotice.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
PaymentNotice.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
PaymentNotice.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PaymentNotice.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentNotice.paymentStatus Base example Payment Status Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PaymentNotice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PaymentNotice 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 PaymentNotice 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 PaymentNotice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PaymentNotice 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 PaymentNotice

Summary

Mandatory: 8 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice 0..* PaymentNotice PaymentNotice request
... id Σ 1..1 id A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
... meta Σ 1..1 Meta Metadata about a resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier 1..1 Identifier A unique identifier assigned to this payment notice.
... status ?!Σ 1..1 code The status of the resource instance.
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... created Σ 1..1 dateTime The date when this resource was created.
... provider 1..1 Reference(Organization Profile) The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
... payment Σ 1..1 Reference(PaymentReconciliation) A reference to the payment which is the subject of this notice.
... paymentDate 1..1 date The date when the above payment action occurred.
... payee 1..1 Reference(Organization Profile) The party who will receive or has received payment that is the subject of this notification.
... recipient Σ 1..1 Reference(Organization) The party who is notified of the payment status.
... amount Σ 1..1 Money The amount sent to the payee.
... paymentStatus 1..1 CodeableConcept A code indicating whether payment has been sent or cleared.
Binding: PaymentStatusCodes (example): The payment conveyance status codes.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentNotice.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentNotice.paymentStatus Base example Payment Status Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PaymentNotice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PaymentNotice 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 PaymentNotice 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 PaymentNotice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PaymentNotice 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 PaymentNotice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice 0..* PaymentNotice PaymentNotice request
... id 1..1 id A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
... meta 1..1 Meta Metadata about a resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier 1..1 Identifier A unique identifier assigned to this payment notice.
... created 1..1 dateTime The date when this resource was created.
... provider 1..1 Reference(Organization Profile) The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
... payment 1..1 Reference(PaymentReconciliation) A reference to the payment which is the subject of this notice.
... paymentDate 1..1 date The date when the above payment action occurred.
... payee 1..1 Reference(Organization Profile) The party who will receive or has received payment that is the subject of this notification.
... recipient 1..1 Reference(Organization) The party who is notified of the payment status.
... amount 1..1 Money The amount sent to the payee.
... paymentStatus 1..1 CodeableConcept A code indicating whether payment has been sent or cleared.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice 0..* PaymentNotice PaymentNotice request
... id Σ 1..1 id A unique identifier genreated by the source system to identify the organization resource. This ID must be unique within the bundle, and will be used to reference the organization resource when it is needed within other resources.
... meta Σ 1..1 Meta Metadata about a resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 Identifier A unique identifier assigned to this payment notice.
... status ?!Σ 1..1 code The status of the resource instance.
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... request 0..1 Reference(Resource) Request reference
... response 0..1 Reference(Resource) Response reference
... created Σ 1..1 dateTime The date when this resource was created.
... provider 1..1 Reference(Organization Profile) The practitioner who is responsible for the services rendered to the patient. Usually the same party as the .payee.
... payment Σ 1..1 Reference(PaymentReconciliation) A reference to the payment which is the subject of this notice.
... paymentDate 1..1 date The date when the above payment action occurred.
... payee 1..1 Reference(Organization Profile) The party who will receive or has received payment that is the subject of this notification.
... recipient Σ 1..1 Reference(Organization) The party who is notified of the payment status.
... amount Σ 1..1 Money The amount sent to the payee.
... paymentStatus 1..1 CodeableConcept A code indicating whether payment has been sent or cleared.
Binding: PaymentStatusCodes (example): The payment conveyance status codes.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentNotice.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
PaymentNotice.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
PaymentNotice.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PaymentNotice.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentNotice.paymentStatus Base example Payment Status Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PaymentNotice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PaymentNotice 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 PaymentNotice 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 PaymentNotice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PaymentNotice 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 PaymentNotice

Summary

Mandatory: 8 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron