FHIR Implementation Guide for ABDM
7.0.0 - active India flag

Banner

FHIR Implementation Guide for ABDM - Local Development build (v7.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PaymentNotice

Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/PaymentNotice Version: 7.0.0
Draft as of 2025-03-18 Computable Name: PaymentNotice

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

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
... 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.
... created Σ 1..1 dateTime Creation date
... provider 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... payment Σ 1..1 Reference(PaymentReconciliation) Payment reference
... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Party being paid
... recipient Σ 1..1 Reference(Organization) Party being notified
... amount Σ 1..1 Money Monetary amount of the payment

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.

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
... request 0..1 Reference(Resource) Request reference
... provider 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... payment 1..1 Reference(PaymentReconciliation) Payment reference
... recipient 1..1 Reference(Organization) Party being notified

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice 0..* PaymentNotice PaymentNotice request
... 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
... 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 0..* Identifier Business Identifier for the payment noctice
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
... request 0..1 Reference(Resource) Request reference
... response 0..1 Reference(Resource) Response reference
... created Σ 1..1 dateTime Creation date
... provider 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... payment Σ 1..1 Reference(PaymentReconciliation) Payment reference
... paymentDate 0..1 date Payment or clearing date
... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Party being paid
... recipient Σ 1..1 Reference(Organization) Party being notified
... amount Σ 1..1 Money Monetary amount of the payment
... paymentStatus 0..1 CodeableConcept Issued or cleared Status of the payment
Binding: PaymentStatusCodes (example): The payment conveyance status codes.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice 0..* PaymentNotice PaymentNotice request
... 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.
... created Σ 1..1 dateTime Creation date
... provider 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... payment Σ 1..1 Reference(PaymentReconciliation) Payment reference
... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Party being paid
... recipient Σ 1..1 Reference(Organization) Party being notified
... amount Σ 1..1 Money Monetary amount of the payment

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.

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
... request 0..1 Reference(Resource) Request reference
... provider 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... payment 1..1 Reference(PaymentReconciliation) Payment reference
... recipient 1..1 Reference(Organization) Party being notified

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentNotice 0..* PaymentNotice PaymentNotice request
... 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
... 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 0..* Identifier Business Identifier for the payment noctice
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
... request 0..1 Reference(Resource) Request reference
... response 0..1 Reference(Resource) Response reference
... created Σ 1..1 dateTime Creation date
... provider 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... payment Σ 1..1 Reference(PaymentReconciliation) Payment reference
... paymentDate 0..1 date Payment or clearing date
... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Party being paid
... recipient Σ 1..1 Reference(Organization) Party being notified
... amount Σ 1..1 Money Monetary amount of the payment
... paymentStatus 0..1 CodeableConcept Issued or cleared Status of the payment
Binding: PaymentStatusCodes (example): The payment conveyance status codes.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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()

 

Other representations of profile: CSV, Excel, Schematron