type: resource-definitionsresource: PaymentNotice

PaymentNotice Definitions

PaymentNotice

PaymentNotice request

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

Cardinality: 0..*

Mappings: workflow=Event; rim=n/a; w5=financial.payment

PaymentNotice.identifier

Business Identifier for the payment notice

Definition: A unique identifier assigned to this payment notice.

Requirements: Allows payment notices to be distinguished and referenced.

Cardinality: 0..*

Type: Identifier

Mappings: workflow=Event.identifier; w5=FiveWs.identifier; rim=n/a

PaymentNotice.status

active | cancelled | draft | entered-in-error

Definition: The status of the resource instance.

Comments: This element is labeled as a modifier because the status contains codes that mark the resource as not currently 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'.

Cardinality: 1..1

Type: code

Binding: required:fm-status

Summary: true

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)

Mappings: workflow=Event.status; w5=FiveWs.status; rim=n/a

PaymentNotice.statusReason

Reason for status change

Definition: Used to indicate why the status has changed.

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

Requirements: This is used to implement conformance on other elements.

Cardinality: 0..1

Type: string

Summary: true

PaymentNotice.request

Request reference

Definition: Reference of resource for which payment is being made.

Cardinality: 0..1

Type: Reference(Resource)

Mappings: workflow=Event.basedOn; w5=FiveWs.subject

PaymentNotice.response

Response reference

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

Cardinality: 0..1

Type: Reference(Resource)

Mappings: w5=FiveWs.subject; rim=n/a

PaymentNotice.created

Creation date

Definition: The date when this resource was created.

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

Cardinality: 1..1

Type: dateTime

Summary: true

Mappings: workflow=Event.occurrence[x]; w5=FiveWs.recorded; rim=n/a

PaymentNotice.reporter

Responsible practitioner

Definition: The party who reports the payment notice.

Cardinality: 0..1

Type: Reference(Practitioner, PractitionerRole, Organization)

Mappings: workflow=Event.performer; w5=FiveWs.source; cdanetv4=B01; v2=B01; rim=n/a

PaymentNotice.payment

Payment reference

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

Requirements: Need to identify the actual payment.

Cardinality: 0..1

Type: Reference(PaymentReconciliation)

Summary: true

PaymentNotice.paymentDate

Payment or clearing date

Definition: The date when the above payment action occurred.

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

Cardinality: 0..1

Type: date

PaymentNotice.payee

Party being paid

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

Cardinality: 0..1

Type: Reference(Practitioner, PractitionerRole, Organization)

PaymentNotice.recipient

Party being notified

Definition: The party who is notified of the payment status.

Requirements: Need to identified the recipient of the notification.

Cardinality: 1..1

Type: Reference(Organization)

Summary: true

Mappings: rim=n/a

PaymentNotice.amount

Monetary amount of the payment

Definition: The amount sent to the payee.

Requirements: Provided for validation purposes.

Cardinality: 1..1

Type: Money

Summary: true

PaymentNotice.paymentStatus

Issued or cleared Status of the payment

Definition: A code indicating whether payment has been sent or cleared.

Comments: Typically paid: payment sent, cleared: payment received.

Requirements: The purpose of the notification.

Cardinality: 0..1

Type: CodeableConcept

Binding: preferred:payment-status

Mappings: rim=n/a