Optional free-text reason recorded when a DocumentReference is marked superseded or entered in error. Never required — a status change with no reason is normal, and an active document carries none.
Elements / Details
Every element this profile touches, with its full definition. Element names in the tables link here.
Why this document is superseded or entered in error
Definition
Free text explaining why the document left the current status: what replaced a superseded
document, or what made an entered-in-error one wrong (a duplicate upload, the wrong patient's
chart). Recorded at the moment the status changes, by the person changing it.
The extension is always optional: staff record a reason when they have one, and the absence of a
reason carries no meaning. Nothing in the model should require it, and consumers must render a
status change with no reason as a complete record.
The reason belongs to the status it was recorded with. Because the DocumentReference is updated
in place, each stored version keeps the reason that applied to that version — reading a historical
version yields that version's reason. A document made current again carries no reason at all:
writers remove the extension on reactivation rather than leaving a stale explanation on an
active document.
Free text only: a code set could not name the replacement or the mistake without losing the
detail that makes the reason useful to the next person reading the chart.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Source of the definition for the extension code - a logical name or a URL.
Comments
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.