FHIR Implementation Guide for ABDM
3.0.0 - CI Build
FHIR Implementation Guide for ABDM
3.0.0 - CI Build
FHIR Implementation Guide for ABDM - Local Development build (v3.0.0). See the Directory of published versions
| Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/PaymentNotice | Version: 3.0.0 | |||
| Draft as of 2023-04-20 | Computable Name: PaymentNotice | |||
This profile represents minimum expectation for PaymentNotice resource, which indicates the resource for which the payment has been indicated and reports the current status information of that payment. The payment notice may be used by providers and payers to advise the provider or regulatory bodies of the state of a payment (check in the mail/EFT sent, payment cashed, payment canceled). Employers or Insurance Exchanges may use this to advise payers of premium payment.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PaymentNotice
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Structures
This structure refers to these other structures:
This structure is derived from PaymentNotice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
  identifier | 1..* | Identifier | Business Identifier for the payment noctice | |
| request | 1..1 | Reference(Resource) | Request reference | |
 response | ||||
  identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
 provider | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 | |
 identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 | 1..* | 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 | 1..1 | Reference(Resource) | Request reference | |||||
| response | 0..1 | Reference(Resource) | Response reference | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| created | Σ | 1..1 | dateTime | Creation date | ||||
| provider | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
| Documentation for this format | ||||
This structure is derived from PaymentNotice
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Structures
This structure refers to these other structures:
Differential View
This structure is derived from PaymentNotice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
| identifier | 1..* | Identifier | Business Identifier for the payment noctice | |
| request | 1..1 | Reference(Resource) | Request reference | |
| response | ||||
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| provider | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 | |
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 | 1..* | 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 | 1..1 | Reference(Resource) | Request reference | |||||
| response | 0..1 | Reference(Resource) | Response reference | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| created | Σ | 1..1 | dateTime | Creation date | ||||
| provider | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| PaymentNotice.language | preferred | CommonLanguages Max Binding: AllLanguages |
| PaymentNotice.status | required | FinancialResourceStatusCodes |
| PaymentNotice.response.type | extensible | ResourceType |
| PaymentNotice.provider.type | extensible | ResourceType |
| PaymentNotice.recipient.type | extensible | ResourceType |
| PaymentNotice.paymentStatus | example | PaymentStatusCodes |
| Id | Grade | Path | 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 | PaymentNotice.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.response.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.response.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.response.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.response.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.created | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.provider | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.provider.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.provider.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.provider.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.provider.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.provider.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.provider.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.payment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.paymentDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.payee | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.recipient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.recipient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.recipient.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.recipient.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.recipient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.recipient.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.amount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.paymentStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |