Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

13.8.6 13.8.7 Resource PaymentNotice - Detailed Descriptions

Responsible Owner: Financial Management icon Work Group Maturity Level : 2   Trial Use Normative Security Category : Patient Compartments : Practitioner

Detailed Descriptions for the elements in the PaymentNotice resource.

PaymentNotice
Element Id PaymentNotice
Definition

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

Short Display PaymentNotice request
Cardinality 0..*
Type DomainResource
Summary false
PaymentNotice.identifier
Element Id PaymentNotice.identifier
Definition

A unique identifier assigned to this payment notice.

Note Short Display Business Identifier for the payment notice
Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Requirements

Allows payment notices to be distinguished and referenced.

Summary false
PaymentNotice.status
Element Id PaymentNotice.status
Definition

The status of the resource instance.

Short Display active | cancelled | draft | entered-in-error
Cardinality 1..1
Terminology Binding Financial Resource Status Codes ( Required )
Type code
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Requirements

Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

Summary true
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

PaymentNotice.statusReason
Element Id PaymentNotice.statusReason
Definition

Used to indicate why the status has changed.

Short Display Reason for status change
Cardinality 0..1
Type string
Requirements

This is used to implement conformance on other elements.

Summary true
Comments

Implementation guides may consider adding invariants such that if status = cancelled, statusReason SHALL be supplied.

PaymentNotice.request
Element Id PaymentNotice.request
Definition

Reference of resource for which payment is being made.

Short Display Request reference
Cardinality 0..1
Type Reference ( Any )
Summary false
PaymentNotice.response
Element Id PaymentNotice.response
Definition

Reference of response to resource for which payment is being made.

Short Display Response reference
Cardinality 0..1
Type Reference ( Any )
Summary false
PaymentNotice.created
Element Id PaymentNotice.created
Definition

The date when this resource was created.

Short Display Creation date
Cardinality 1..1
Type dateTime
Requirements

Need to record a timestamp for use by both the recipient and the issuer.

Summary true
PaymentNotice.provider PaymentNotice.reporter
Element Id PaymentNotice.provider PaymentNotice.reporter
Definition

The practitioner party who is responsible for the services rendered to reports the patient. payment notice.

Short Display Responsible practitioner
Cardinality 0..1
Type Reference ( Practitioner | PractitionerRole | Organization )
Summary false
PaymentNotice.payment
Element Id PaymentNotice.payment
Definition

A reference to the payment which is the subject of this notice.

Short Display Payment reference
Cardinality 1..1 0..1
Type Reference ( PaymentReconciliation )
Requirements

Need to identify the actual payment.

Summary true
PaymentNotice.paymentDate
Element Id PaymentNotice.paymentDate
Definition

The date when the above payment action occurred.

Short Display Payment or clearing date
Cardinality 0..1
Type date
Requirements

Need to convey the date when the action being notified occurred.

Summary false
PaymentNotice.payee
Element Id PaymentNotice.payee
Definition

The party who will receive or has received payment that is the subject of this notification.

Short Display Party being paid
Cardinality 0..1
Type Reference ( Practitioner | PractitionerRole | Organization )
Summary false
PaymentNotice.recipient
Element Id PaymentNotice.recipient
Definition

The party who is notified of the payment status.

Short Display Party being notified
Cardinality 1..1
Type Reference ( Organization )
Requirements

Need to identified the recipient of the notification.

Summary true
PaymentNotice.amount
Element Id PaymentNotice.amount
Definition

The amount sent to the payee.

Short Display Monetary amount of the payment
Cardinality 1..1
Type Money
Requirements

Provided for validation purposes.

Summary true
PaymentNotice.paymentStatus
Element Id PaymentNotice.paymentStatus
Definition

A code indicating whether payment has been sent or cleared.

Short Display Issued or cleared Status of the payment
Cardinality 0..1
Terminology Binding Payment Status Codes ( Example Preferred )
Type CodeableConcept
Requirements

The purpose of the notification.

Comments Summary false
Comments

Typically paid: payment sent, cleared: payment received.