Skip to content

Sign-off Comment Extension

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-emr-sign-off-comment
Statusdraft · 1.33.0
BaseExtension (constraint)
ContextAnnotation (element), Communication (element)
SourceFSH · JSON

Marks a comment as made together with a review sign-off, naming the review Task whose sign-off it was made with. Rides the comment itself -- the Annotation of a resource-note thread, or the Communication of a thread made of resources -- so readers can present the remark as accompanying the attestation.

FSH

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

// SignOffCommentExtension.fsh
// Marks a comment as having been made together with a review sign-off.
//
// WHY MARK IT. A reviewer who signs off a document or a report can say why in the same act --
// "reviewed, no action needed". That remark is an ordinary comment in the artifact's thread, and
// without a marker nothing distinguishes it from a remark made a day earlier: a reader of the
// thread could not tell which comment accompanied the attestation. The marker names the review
// Task whose sign-off the comment was made with, so the thread can present the comment as made
// with that sign-off and an auditor can walk from the remark to the review it belongs to.
//
// WHERE IT RIDES. On the comment itself, in whichever form the artifact's thread takes: the
// Annotation of a resource-note thread (a DocumentReference's comments), or the Communication
// of a thread made of resources (the comments on a DiagnosticReport). One extension for both,
// so "was this said with a sign-off" is one question with one answer across the EMR.
//
// WRITE ORDER. The marker asserts that a sign-off was made, so a writer records it only with a
// sign-off that landed. Where the comment rides the artifact, the comment and the review stamp are
// one save and the review Task is completed after it; where the comment is a resource of its own,
// it is written after the review Task has completed. A marked comment beside a sign-off that
// failed would tell the next reader something untrue. The marker does not assert that the Task
// it names completed: on the first path, a Task write that fails after the save leaves the named
// Task open.

Extension: SignOffCommentExtension
Id: nexus-emr-sign-off-comment
Title: "Sign-off Comment Extension"
Description: "Marks a comment as made together with a review sign-off, naming the review Task whose sign-off it was made with. Rides the comment itself -- the Annotation of a resource-note thread, or the Communication of a thread made of resources -- so readers can present the remark as accompanying the attestation."
* ^url = "https://fhir.apps.health/StructureDefinition/nexus-emr-sign-off-comment"
* ^status = #draft
* ^date = "2026-09-21"
* ^publisher = "WELLSTAR Technologies Corp."
* ^contact.name = "Nexus EMR FHIR Implementation Guide"
* ^contact.telecom.system = #url
* ^contact.telecom.value = "https://fhir.apps.health"
* ^jurisdiction = urn:iso:std:iso:3166#CA "Canada"
* ^context[0].type = #element
* ^context[0].expression = "Annotation"
* ^context[1].type = #element
* ^context[1].expression = "Communication"
* . ^short = "The review Task whose sign-off this comment was made with"
* . ^definition = "The review Task whose sign-off the comment was made with."
* . ^comment = "Present only on a comment made with a sign-off. Taking the sign-off back later does not remove the comment or this marker: the remark was made with that sign-off, and the Task's own history records what became of it."
* extension 0..0
* url 1..1
* value[x] 1..1 MS
* value[x] only Reference(Task)
* value[x] ^short = "The review Task of the sign-off"