FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Financial Management icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Patient Compartments: Practitioner

Detailed Descriptions for the elements in the PaymentNotice resource.

PaymentNotice
Definition

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

Short DisplayPaymentNotice request
Cardinality0..*
TypeDomainResource
Summaryfalse
PaymentNotice.identifier
Definition

A unique identifier assigned to this payment notice.

Short DisplayBusiness Identifier for the payment notice
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows payment notices to be distinguished and referenced.

Summaryfalse
PaymentNotice.status
Definition

The status of the resource instance.

Short Displayactive | cancelled | draft | entered-in-error
Cardinality1..1
Terminology BindingFinancial Resource Status Codes (Required)
Typecode
Is Modifiertrue (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'.

Summarytrue
Comments

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

PaymentNotice.request
Definition

Reference of resource for which payment is being made.

Short DisplayRequest reference
Cardinality0..1
TypeReference(Any)
Summaryfalse
PaymentNotice.response
Definition

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

Short DisplayResponse reference
Cardinality0..1
TypeReference(Any)
Summaryfalse
PaymentNotice.created
Definition

The date when this resource was created.

Short DisplayCreation date
Cardinality1..1
TypedateTime
Requirements

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

Summarytrue
PaymentNotice.reporter
Definition

The party who reports the payment notice.

Short DisplayResponsible practitioner
Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization)
Summaryfalse
PaymentNotice.payment
Definition

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

Short DisplayPayment reference
Cardinality0..1
TypeReference(PaymentReconciliation)
Requirements

Need to identify the actual payment.

Summarytrue
PaymentNotice.paymentDate
Definition

The date when the above payment action occurred.

Short DisplayPayment or clearing date
Cardinality0..1
Typedate
Requirements

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

Summaryfalse
PaymentNotice.payee
Definition

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

Short DisplayParty being paid
Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization)
Summaryfalse
PaymentNotice.recipient
Definition

The party who is notified of the payment status.

Short DisplayParty being notified
Cardinality1..1
TypeReference(Organization)
Requirements

Need to identified the recipient of the notification.

Summarytrue
PaymentNotice.amount
Definition

The amount sent to the payee.

Short DisplayMonetary amount of the payment
Cardinality1..1
TypeMoney
Requirements

Provided for validation purposes.

Summarytrue
PaymentNotice.paymentStatus
Definition

A code indicating whether payment has been sent or cleared.

Short DisplayIssued or cleared Status of the payment
Cardinality0..1
Terminology BindingPayment Status Codes (Example)
TypeCodeableConcept
Requirements

The purpose of the notification.

Summaryfalse
Comments

Typically paid: payment sent, cleared: payment received.