PaymentNotice - FHIR v5.0.0-snapshot1

Release 5 Snapshot #1

This page is part of the FHIR Specification (v5.0.0-snapshot1: R5 Snapshot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

13.8.7 Resource PaymentNotice - Detailed Descriptions

Financial Management

Work Group

Maturity Level: 2

Trial Use

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.
Cardinality	0..*
Type	DomainResource
Summary	false
PaymentNotice.identifier
Element Id	PaymentNotice.identifier
Definition	A unique identifier assigned to this 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.
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.request
Element Id	PaymentNotice.request
Definition	Reference of resource for which payment is being made.
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.
Cardinality	0..1
Type	Reference(Any)
Summary	false
PaymentNotice.created
Element Id	PaymentNotice.created
Definition	The date when this resource was created.
Cardinality	1..1
Type	dateTime
Requirements	Need to record a timestamp for use by both the recipient and the issuer.
Summary	true
PaymentNotice.provider
Element Id	PaymentNotice.provider
Definition	The practitioner who is responsible for the services rendered to the patient.
Cardinality	0..1
Type	Reference(Practitioner \| PractitionerRole \| Organization)
Patterns	Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant
Summary	false
PaymentNotice.payment
Element Id	PaymentNotice.payment
Definition	A reference to the payment which is the subject of this notice.
Cardinality	1..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.
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.
Cardinality	0..1
Type	Reference(Practitioner \| PractitionerRole \| Organization)
Patterns	Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant
Summary	false
PaymentNotice.recipient
Element Id	PaymentNotice.recipient
Definition	The party who is notified of the payment status.
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.
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.
Cardinality	0..1
Terminology Binding	Payment Status Codes (Example)
Type	CodeableConcept
Requirements	The purpose of the notification.
Summary	false
Comments	Typically paid: payment sent, cleared: payment received.