Fact of Death Exchange FHIR Implementation Guide
0.2.0 - CI Build United States of America flag

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 Acknowledgement Message Header

Official URL: http://example.org/fhir/us/fod/StructureDefinition/fod-acknowledgement-message-header Version: 0.2.0
Standards status: Informative Maturity Level: 1 Computable Name: FODAcknowledgementMessageHeader

The header of a message acknowledging a fact-of-death notification. It echoes the event code of the notification being acknowledged and identifies that notification through MessageHeader.response.identifier.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding The event code of the notification being acknowledged
Binding: Fact of Death Notification Event Value Set (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... response SΣ 1..1 BackboneElement If this is a reply to prior message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier SΣ 1..1 id The MessageHeader.id of the notification being acknowledged. Senders SHOULD set that id to their notification's Bundle.identifier value so that the two are interchangeable when reconciling.
.... code SΣ 1..1 code Whether the notification was processed. A notification that was received cleanly but matched nothing is 'ok'; the match outcome is carried separately.
Binding: ResponseType (required): The kind of response to a message.
.... details SΣ 1..1 Reference(Fact of Death Match Outcome) The match outcome reported for this notification

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base required Fact of Death Notification Event Value Set 📦0.2.0 This IG
MessageHeader.response.​code Base required ResponseType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
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()

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader MessageHeader
... event[x] S 1..1 Coding The event code of the notification being acknowledged
Binding: Fact of Death Notification Event Value Set (required)
... source S 1..1 BackboneElement Message source application
... response S 1..1 BackboneElement If this is a reply to prior message
.... identifier S 1..1 id The MessageHeader.id of the notification being acknowledged. Senders SHOULD set that id to their notification's Bundle.identifier value so that the two are interchangeable when reconciling.
.... code S 1..1 code Whether the notification was processed. A notification that was received cleanly but matched nothing is 'ok'; the match outcome is carried separately.
.... details S 1..1 Reference(Fact of Death Match Outcome) The match outcome reported for this notification

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base required Fact of Death Notification Event Value Set 📦0.2.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding The event code of the notification being acknowledged
Binding: Fact of Death Notification Event Value Set (required)
... destination Σ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source SΣ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
... response SΣ 1..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier SΣ 1..1 id The MessageHeader.id of the notification being acknowledged. Senders SHOULD set that id to their notification's Bundle.identifier value so that the two are interchangeable when reconciling.
.... code SΣ 1..1 code Whether the notification was processed. A notification that was received cleanly but matched nothing is 'ok'; the match outcome is carried separately.
Binding: ResponseType (required): The kind of response to a message.
.... details SΣ 1..1 Reference(Fact of Death Match Outcome) The match outcome reported for this notification
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageHeader.event[x] Base required Fact of Death Notification Event Value Set 📦0.2.0 This IG
MessageHeader.reason Base example Example Message Reason Codes 📍4.0.1 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
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()

This structure is derived from MessageHeader

Summary

Mandatory: 2 elements
Must-Support: 6 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding The event code of the notification being acknowledged
Binding: Fact of Death Notification Event Value Set (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... response SΣ 1..1 BackboneElement If this is a reply to prior message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier SΣ 1..1 id The MessageHeader.id of the notification being acknowledged. Senders SHOULD set that id to their notification's Bundle.identifier value so that the two are interchangeable when reconciling.
.... code SΣ 1..1 code Whether the notification was processed. A notification that was received cleanly but matched nothing is 'ok'; the match outcome is carried separately.
Binding: ResponseType (required): The kind of response to a message.
.... details SΣ 1..1 Reference(Fact of Death Match Outcome) The match outcome reported for this notification

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base required Fact of Death Notification Event Value Set 📦0.2.0 This IG
MessageHeader.response.​code Base required ResponseType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
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()

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader MessageHeader
... event[x] S 1..1 Coding The event code of the notification being acknowledged
Binding: Fact of Death Notification Event Value Set (required)
... source S 1..1 BackboneElement Message source application
... response S 1..1 BackboneElement If this is a reply to prior message
.... identifier S 1..1 id The MessageHeader.id of the notification being acknowledged. Senders SHOULD set that id to their notification's Bundle.identifier value so that the two are interchangeable when reconciling.
.... code S 1..1 code Whether the notification was processed. A notification that was received cleanly but matched nothing is 'ok'; the match outcome is carried separately.
.... details S 1..1 Reference(Fact of Death Match Outcome) The match outcome reported for this notification

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base required Fact of Death Notification Event Value Set 📦0.2.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding The event code of the notification being acknowledged
Binding: Fact of Death Notification Event Value Set (required)
... destination Σ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source SΣ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
... response SΣ 1..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier SΣ 1..1 id The MessageHeader.id of the notification being acknowledged. Senders SHOULD set that id to their notification's Bundle.identifier value so that the two are interchangeable when reconciling.
.... code SΣ 1..1 code Whether the notification was processed. A notification that was received cleanly but matched nothing is 'ok'; the match outcome is carried separately.
Binding: ResponseType (required): The kind of response to a message.
.... details SΣ 1..1 Reference(Fact of Death Match Outcome) The match outcome reported for this notification
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageHeader.event[x] Base required Fact of Death Notification Event Value Set 📦0.2.0 This IG
MessageHeader.reason Base example Example Message Reason Codes 📍4.0.1 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
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()

This structure is derived from MessageHeader

Summary

Mandatory: 2 elements
Must-Support: 6 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron