Current Build
Financial Management Work GroupMaturity Level: 2 Trial UseSecurity Category: Patient Compartments: Practitioner

Detailed Descriptions for the elements in the PaymentNotice resource.

PaymentNotice
Element IdPaymentNotice
Definition

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

Cardinality0..*
TypeDomainResource
PaymentNotice.identifier
Element IdPaymentNotice.identifier
Definition

A unique identifier assigned to this payment notice.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows payment notices to be distinguished and referenced.

PaymentNotice.status
Element IdPaymentNotice.status
Definition

The status of the resource instance.

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
Element IdPaymentNotice.request
Definition

Reference of resource for which payment is being made.

Cardinality0..1
TypeReference(Any)
PaymentNotice.response
Element IdPaymentNotice.response
Definition

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

Cardinality0..1
TypeReference(Any)
PaymentNotice.created
Element IdPaymentNotice.created
Definition

The date when this resource was created.

Cardinality1..1
TypedateTime
Requirements

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

Summarytrue
PaymentNotice.provider
Element IdPaymentNotice.provider
Definition

The practitioner who is responsible for the services rendered to the patient.

Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization)
PatternsReference(Practitioner,PractitionerRole,Organization): Common patterns = Participant
PaymentNotice.payment
Element IdPaymentNotice.payment
Definition

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

Cardinality1..1
TypeReference(PaymentReconciliation)
Requirements

Need to identify the actual payment.

Summarytrue
PaymentNotice.paymentDate
Element IdPaymentNotice.paymentDate
Definition

The date when the above payment action occurred.

Cardinality0..1
Typedate
Requirements

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

PaymentNotice.payee
Element IdPaymentNotice.payee
Definition

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

Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization)
PatternsReference(Practitioner,PractitionerRole,Organization): Common patterns = Participant
PaymentNotice.recipient
Element IdPaymentNotice.recipient
Definition

The party who is notified of the payment status.

Cardinality1..1
TypeReference(Organization)
Requirements

Need to identified the recipient of the notification.

Summarytrue
PaymentNotice.amount
Element IdPaymentNotice.amount
Definition

The amount sent to the payee.

Cardinality1..1
TypeMoney
Requirements

Provided for validation purposes.

Summarytrue
PaymentNotice.paymentStatus
Element IdPaymentNotice.paymentStatus
Definition

A code indicating whether payment has been sent or cleared.

Cardinality0..1
Terminology BindingPayment Status Codes (Example)
TypeCodeableConcept
Requirements

The purpose of the notification.

Comments

Typically paid: payment sent, cleared: payment received.