Fact of Death Exchange FHIR Implementation Guide
0.2.0 - CI Build
Fact of Death Exchange FHIR Implementation Guide
0.2.0 - CI Build
Fact of Death Exchange FHIR Implementation Guide, published by HL7 International - Public Health Work Group. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/shpringman/fhir-fod/ and changes regularly. See the Directory of published versions
| Page standards status: Informative | Maturity Level: 1 |
{
"resourceType" : "CapabilityStatement",
"id" : "fod-receiver",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement fod-receiver</b></p><a name=\"fod-receiver\"> </a><a name=\"hcfod-receiver\"> </a><h2 id=\"title\">Fact of Death Receiver Capability Statement</h2><ul><li>Implementation Guide Version: 0.2.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Published on: 2026-08-07 </li><li>Published by: HL7 International - Public Health Work Group </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>Notifications are delivered by invoking $process-message at the server root with a Fact of Death Notification Bundle as the message. A receiver that supports acknowledgement returns a Fact of Death Acknowledgement Bundle synchronously in the operation response.</p>\n</div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Summary of System-wide Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$process-message</td><td><div/></td></tr></tbody></table></div></div></div></div><h2 id=\"messaging\">FHIR Messaging Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"messaging_1\" class=\"panel-title\">Messaging Capability</h3></div><div class=\"panel-body\"><h4 id=\"msg_sm_1\">Supported Message(s)</h4><table class=\"table table-condensed table-hover\"><thead><tr><th>Mode</th><th>Definition</th></tr></thead><tbody><tr><td>receiver</td><td><a href=\"MessageDefinition-fod-notification.html\">Fact of Death Notification Message</a></td></tr><tr><td>receiver</td><td><a href=\"MessageDefinition-fod-correction.html\">Fact of Death Correction Message</a></td></tr><tr><td>receiver</td><td><a href=\"MessageDefinition-fod-void.html\">Fact of Death Void Message</a></td></tr></tbody></table><span class=\"lead\">Documentation</span><blockquote><div><p>A receiver matches each notification to a patient record using its own matching logic. Where it supports acknowledgement, it reports the outcome using the Fact of Death Match Outcome, including the case where no patient record matched.</p>\n</div></blockquote><br/></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://example.org/fhir/us/fod/ImplementationGuide/example.fhir.us.fod"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "informative",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://example.org/fhir/us/fod/ImplementationGuide/example.fhir.us.fod"
}
]
}
}
],
"url" : "http://example.org/fhir/us/fod/CapabilityStatement/fod-receiver",
"version" : "0.2.0",
"name" : "FODReceiver",
"title" : "Fact of Death Receiver Capability Statement",
"status" : "draft",
"experimental" : false,
"date" : "2026-08-07",
"publisher" : "HL7 International - Public Health Work Group",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://hl7.org/Special/committees/pher"
}
]
}
],
"description" : "Expectations of a Notification Receiver, typically an EHR, that accepts fact-of-death notifications. A receiver SHALL accept all three message events. Accepting a retraction is not optional: a receiver that can accept a death but not withdraw it cannot be corrected when a jurisdiction registers a death against the wrong individual.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"rest" : [
{
"mode" : "server",
"documentation" : "Notifications are delivered by invoking $process-message at the server root with a Fact of Death Notification Bundle as the message. A receiver that supports acknowledgement returns a Fact of Death Acknowledgement Bundle synchronously in the operation response.",
"operation" : [
{
"name" : "process-message",
"definition" : "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
}
]
}
],
"messaging" : [
{
"documentation" : "A receiver matches each notification to a patient record using its own matching logic. Where it supports acknowledgement, it reports the outcome using the Fact of Death Match Outcome, including the case where no patient record matched.",
"supportedMessage" : [
{
"mode" : "receiver",
"definition" : "http://example.org/fhir/us/fod/MessageDefinition/fod-notification"
},
{
"mode" : "receiver",
"definition" : "http://example.org/fhir/us/fod/MessageDefinition/fod-correction"
},
{
"mode" : "receiver",
"definition" : "http://example.org/fhir/us/fod/MessageDefinition/fod-void"
}
]
}
]
}