Skip to content

Payment Reason Extension

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-payment-reason
Statusdraft · 1.33.0
BaseExtension (constraint)
ContextPaymentReconciliation (element)
SourceFSH · JSON

Why a payment was reversed, or why a refund was given, as the office wrote it.

FSH

The authored source of truth: extensions/PaymentReasonExtension.fsh (edit on GitHub). One FSH file may define several related artifacts.

// PaymentReasonExtension.fsh
// Why a payment was reversed, or why a refund was given. Carried on `PaymentReconciliation`.
//
// R4 HAS NO ELEMENT FOR IT. `PaymentReconciliation.disposition` is the payer's message about the
// remittance and `processNote` is a note on the payment as taken; neither says why the clinic later
// undid it or gave money back. R5 adds no such element either.
//
// FREE TEXT, AS THE OFFICE WROTE IT. The reasons are as varied as the mistakes that cause them --
// the wrong invoice, the wrong amount, a duplicate, a cancelled service -- and the text is read
// back by people, so it is stored as typed rather than coded.

Extension: NexusPaymentReason
Id: nexus-payment-reason
Title: "Payment Reason Extension"
Description: """
Why a payment was reversed, or why a refund was given, as the office wrote it.

**Required where it applies.** A cancelled (reversed) reconciliation and every refund carry one; the
[Payment Reconciliation Profile](StructureDefinition-nexus-core-paymentreconciliation.md) enforces
both.

**It describes the last write.** A reversal writes a new version of the reconciliation, and the
reason on the current version explains that write. Read the version history for what came before.

**At most one.**
"""
* ^url = "https://fhir.apps.health/StructureDefinition/nexus-payment-reason"
* ^status = #draft
* ^context[0].type = #element
* ^context[0].expression = "PaymentReconciliation"
* extension 0..0
* url 1..1
* value[x] 1..1 MS
* value[x] only string
* valueString ^short = "Why it was reversed or refunded"