Skip to content

Consent Status Reason Extension

Canonical../StructureDefinition/nexus-consent-status-reason
Statusdraft · 1.26.0
BaseExtension (constraint)
ContextConsent (element)
SourceFSH · JSON

Optional free-text reason recorded when a consent status changes, typically on revocation (Provided to Declined). Never required — a status change with no reason is normal.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

Extension

Short Why this consent status was recorded
Definition Free text explaining why the consent reached its current status. Most often carries what the patient said when withdrawing a consent they had previously provided (status active to rejected), but it is equally valid on an initial decline or on any other status change. The extension is always optional: staff record a reason when the patient offers 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 item consent is updated in place, each stored version keeps the reason that applied to that version — reading a historical version yields that version's reason, not the current one. Free text only: the reason is what the patient said, in the words they said it. Deliberately not coded, since a code set could not be enumerated without losing the detail that makes the reason useful to the next person reading the chart.
Cardinality 0..*
Invariants ele-1, ext-1

Extension.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Extension.extension

Short Additional content defined by implementations
Definition 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.
Cardinality 0..0
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Extension.url

Short identifies the meaning of the extension
Definition 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.
Cardinality 1..1
Type http://hl7.org/fhirpath/System.String
Fixed value ../StructureDefinition/nexus-consent-status-reason

Extension.value[x]

Short Reason for the consent status, as recorded by staff
Definition The reason the patient gave, or the reason staff recorded, for this consent status. Not intended to be parsed.
Cardinality 1..1
Type string
Must Support yes
Invariants ele-1