Fact of Death Notification Bundle - Fact of Death Exchange FHIR Implementation Guide v0.2.0

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

Resource Profile: Fact of Death Notification Bundle

Official URL: http://example.org/fhir/us/fod/StructureDefinition/fod-notification-bundle				Version: 0.2.0
Standards status: Informative			Maturity Level: 1	Computable Name: FODNotificationBundle

A fact-of-death notification, carried as a FHIR message. The bundle conveys the identity of the decedent, the fact and date and time of death, the place of death, and the demographics a receiver needs to match the notification to a patient record. Its content slices deliberately mirror the VRDR Mortality Roster Bundle so that a jurisdiction already producing roster content can reuse the same resource instances. Causes of death, manner of death, and the other content of a death certificate are out of scope for a notification and are not carried here.

Usages:

Examples for this Profile: Bundle/fod-notification-home-partial-date-example and Bundle/fod-notification-hospital-example

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, fod-bundle-identified
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	SΣ	1..1	Identifier	Business identifier of this notification, used by corrections and retractions to reference it
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:certificateNumber	S	0..1	string	Death certificate number assigned by the jurisdiction URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber
extension:auxiliaryStateIdentifier1		0..1	string	Auxiliary State Identifier1 Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1
extension:auxiliaryStateIdentifier2		0..1	string	Auxiliary State Identifier2 Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: message
timestamp	SΣ	1..1	instant	When this notification was assembled for sending
Slices for entry	SΣC	5..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
entry:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	1..1	uri	Required so that references between entries in the message resolve
resource	Σ	1..1	Resource	A resource in the bundle
entry:MessageHeader	SΣC	1..1	BackboneElement	The message header, which SHALL be the first entry Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	1..1	uri	Required so that references between entries in the message resolve
resource		1..1	FODMessageHeader	A resource that describes a message that is exchanged between systems
entry:Decedent	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	1..1	uri	Required so that references between entries in the message resolve
resource		1..1	FODDecedent	Information about an individual or animal receiving health care services
entry:DeathDate	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	1..1	uri	Required so that references between entries in the message resolve
resource		1..1	FODDeathDate	Measurements and simple assertions
entry:DeathLocation	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	1..1	uri	Required so that references between entries in the message resolve
resource		1..1	FODDeathLocation	Details and position information for a physical place
entry:SourceOrganization	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	1..1	uri	Required so that references between entries in the message resolve
resource		1..1	FODSourceOrganization	A grouping of people or organizations with a common purpose
entry:Provenance	SΣC	1..1	BackboneElement	Registration and authorship of the fact of death, which a receiver needs in order to sequence corrections correctly Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	1..1	uri	Required so that references between entries in the message resolve
resource		1..1	FODProvenance	Who, What, When for a set of resources
entry:Certifier	SΣC	0..1	BackboneElement	The practitioner who certified or pronounced the death, where the jurisdiction discloses it Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	1..1	uri	Required so that references between entries in the message resolve
resource		1..1	Certifier	A person with a formal responsibility in the provisioning of healthcare or related services
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Bundle.type	Base	required	BundleType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
bdl-1	error	Bundle	total only when a search or history	`total.empty() or (type = 'searchset') or (type = 'history')`
bdl-2	error	Bundle	entry.search only when a search	`entry.search.empty() or (type = 'searchset')`
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited	`entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))`
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited	`entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))`
bdl-5	error	Bundle.entry, Bundle.entry:MessageHeader, Bundle.entry:Decedent, Bundle.entry:DeathDate, Bundle.entry:DeathLocation, Bundle.entry:SourceOrganization, Bundle.entry:Provenance, Bundle.entry:Certifier	must be a resource unless there's a request or response	`resource.exists() or request.exists() or response.exists()`
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)	`(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()`
bdl-8	error	Bundle.entry, Bundle.entry:MessageHeader, Bundle.entry:Decedent, Bundle.entry:DeathDate, Bundle.entry:DeathLocation, Bundle.entry:SourceOrganization, Bundle.entry:Provenance, Bundle.entry:Certifier	fullUrl cannot be a version specific reference	`fullUrl.contains('/_history/').not()`
bdl-9	error	Bundle	A document must have an identifier with a system and a value	`type = 'document' implies (identifier.system.exists() and identifier.value.exists())`
bdl-10	error	Bundle	A document must have a date	`type = 'document' implies (timestamp.hasValue())`
bdl-11	error	Bundle	A document must have a Composition as the first resource	`type = 'document' implies entry.first().resource.is(Composition)`
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource	`type = 'message' implies entry.first().resource.is(MessageHeader)`
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
fod-bundle-identified	error	Bundle	A notification SHALL have a bundle identifier with both a system and a value, so that a later correction or retraction can unambiguously reference it.	`identifier.system.exists() and identifier.value.exists()`

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Contains a collection of resources Constraints: fod-bundle-identified
identifier	S	1..1	Identifier	Business identifier of this notification, used by corrections and retractions to reference it
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:certificateNumber	S	0..1	string	Death certificate number assigned by the jurisdiction URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber
extension:auxiliaryStateIdentifier1		0..1	string	Auxiliary State Identifier1 Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1
extension:auxiliaryStateIdentifier2		0..1	string	Auxiliary State Identifier2 Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2
type	S	1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Fixed Value: message
timestamp	S	1..1	instant	When this notification was assembled for sending
Slices for entry	S	5..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource
entry:All Slices				Content/Rules for all slices
fullUrl	S	1..1	uri	Required so that references between entries in the message resolve
resource		1..1	Resource	A resource in the bundle
entry:MessageHeader	S	1..1	BackboneElement	The message header, which SHALL be the first entry
resource		1..1	FODMessageHeader	A resource that describes a message that is exchanged between systems
entry:Decedent	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FODDecedent	Information about an individual or animal receiving health care services
entry:DeathDate	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FODDeathDate	Measurements and simple assertions
entry:DeathLocation	S	0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FODDeathLocation	Details and position information for a physical place
entry:SourceOrganization	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FODSourceOrganization	A grouping of people or organizations with a common purpose
entry:Provenance	S	1..1	BackboneElement	Registration and authorship of the fact of death, which a receiver needs in order to sequence corrections correctly
resource		1..1	FODProvenance	Who, What, When for a set of resources
entry:Certifier	S	0..1	BackboneElement	The practitioner who certified or pronounced the death, where the jurisdiction discloses it
resource		1..1	Certifier	A person with a formal responsibility in the provisioning of healthcare or related services
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
fod-bundle-identified	error	Bundle	A notification SHALL have a bundle identifier with both a system and a value, so that a later correction or retraction can unambiguously reference it.	`identifier.system.exists() and identifier.value.exists()`