FHIR Implementation Guide for ABDM
6.5.0 - active
FHIR Implementation Guide for ABDM
6.5.0 - active
This page is part of the FHIR Implementation Guide for ABDM (v6.5.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/PaymentNotice | Version: 6.5.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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PaymentNotice |
0..* | PaymentNotice | PaymentNotice request dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. ele-1: All FHIR elements must have a @value or children |
 request |
0..1 | Reference(Resource) | Request reference ele-1: All FHIR elements must have a @value or children | |
| created |
Σ | 1..1 | dateTime | Creation date ele-1: All FHIR elements must have a @value or children |
| provider |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner ele-1: All FHIR elements must have a @value or children | |
| payment |
Σ | 1..1 | Reference(PaymentReconciliation) | Payment reference ele-1: All FHIR elements must have a @value or children |
| payee |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party being paid ele-1: All FHIR elements must have a @value or children | |
| recipient |
Σ | 1..1 | Reference(Organization) | Party being notified ele-1: All FHIR elements must have a @value or children |
  amount |
Σ | 1..1 | Money | Monetary amount of the payment ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PaymentNotice.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| payee |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party being paid | |
| recipient |
1..1 | Reference(Organization) | Party being notified | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| 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 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. | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PaymentNotice.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| PaymentNotice.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1from the FHIR Standard | ||||
| PaymentNotice.paymentStatus | example | PaymentStatusCodeshttp://hl7.org/fhir/ValueSet/payment-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentNotice |
0..* | PaymentNotice | PaymentNotice request dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. ele-1: All FHIR elements must have a @value or children |
| request |
0..1 | Reference(Resource) | Request reference ele-1: All FHIR elements must have a @value or children | |
| created |
Σ | 1..1 | dateTime | Creation date ele-1: All FHIR elements must have a @value or children |
| provider |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner ele-1: All FHIR elements must have a @value or children | |
| payment |
Σ | 1..1 | Reference(PaymentReconciliation) | Payment reference ele-1: All FHIR elements must have a @value or children |
| payee |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party being paid ele-1: All FHIR elements must have a @value or children | |
| recipient |
Σ | 1..1 | Reference(Organization) | Party being notified ele-1: All FHIR elements must have a @value or children |
| amount |
Σ | 1..1 | Money | Monetary amount of the payment ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PaymentNotice.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| payee |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party being paid | |
| recipient |
1..1 | Reference(Organization) | Party being notified | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| 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 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. | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PaymentNotice.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| PaymentNotice.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1from the FHIR Standard | ||||
| PaymentNotice.paymentStatus | example | PaymentStatusCodeshttp://hl7.org/fhir/ValueSet/payment-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron