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
| Official URL: http://example.org/fhir/us/fod/StructureDefinition/fod-message-header | Version: 0.2.0 | |||
| Standards status: Informative | Maturity Level: 1 | Computable Name: FODMessageHeader | ||
The header of a fact-of-death notification message. The event code tells the receiver whether this is an initial notification, a correction, or a retraction, which is the only information a routing intermediary needs in order to deliver the message without inspecting its clinical content. Acknowledgements use the Fact of Death Acknowledgement Message Header instead; this profile prohibits MessageHeader.response so that the two cannot be confused.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 | Whether this message notifies, corrects, or retracts a fact of death Binding: Fact of Death Notification Event Value Set (required) |
 destination |
SΣ | 1..* | BackboneElement | Message destination application(s) |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Actual destination address or id |
  receiver |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The provider organization the notification is intended for, where known |
| sender |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for sending this message, which may be a relaying intermediary rather than the registering jurisdiction |
| source |
SΣ | 1..1 | BackboneElement | Message source application |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Actual message source address or id |
| focus |
SΣ | 1..1 | Reference(Fact of Death Death Date) | The Death Date observation that carries the fact of death |
| Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| event[x] |
S | 1..1 | Coding | Whether this message notifies, corrects, or retracts a fact of death Binding: Fact of Death Notification Event Value Set (required) |
 destination |
S | 1..* | BackboneElement | Message destination application(s) |
| endpoint |
S | 1..1 | url | Actual destination address or id |
| receiver |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The provider organization the notification is intended for, where known |
| sender |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for sending this message, which may be a relaying intermediary rather than the registering jurisdiction |
| source |
S | 1..1 | BackboneElement | Message source application |
| endpoint |
S | 1..1 | url | Actual message source address or id |
| response |
0..0 | Not used on a notification. Acknowledgements use the Fact of Death Acknowledgement Message Header. | ||
| focus |
S | 1..1 | Reference(Fact of Death Death Date) | The Death Date observation that carries the fact of death |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.event[x] | Base | required | Fact of Death Notification Event Value Set | 📦0.2.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | Whether this message notifies, corrects, or retracts a fact of death Binding: Fact of Death Notification Event Value Set (required) | ||||
| destination |
SΣ | 1..* | 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 |
SΣ | 1..1 | url | Actual destination address or id | ||||
| receiver |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The provider organization the notification is intended for, where known | ||||
| sender |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for sending this message, which may be a relaying intermediary rather than the registering jurisdiction | ||||
| 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 |
SΣ | 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. | ||||
| focus |
SΣ | 1..1 | Reference(Fact of Death Death Date) | The Death Date observation that carries the fact of death | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| 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. |
| 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: 8 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | Whether this message notifies, corrects, or retracts a fact of death Binding: Fact of Death Notification Event Value Set (required) |
| destination |
SΣ | 1..* | BackboneElement | Message destination application(s) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Actual destination address or id |
| receiver |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The provider organization the notification is intended for, where known |
| sender |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for sending this message, which may be a relaying intermediary rather than the registering jurisdiction |
| source |
SΣ | 1..1 | BackboneElement | Message source application |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Actual message source address or id |
| focus |
SΣ | 1..1 | Reference(Fact of Death Death Date) | The Death Date observation that carries the fact of death |
| Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| event[x] |
S | 1..1 | Coding | Whether this message notifies, corrects, or retracts a fact of death Binding: Fact of Death Notification Event Value Set (required) |
| destination |
S | 1..* | BackboneElement | Message destination application(s) |
| endpoint |
S | 1..1 | url | Actual destination address or id |
| receiver |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The provider organization the notification is intended for, where known |
| sender |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for sending this message, which may be a relaying intermediary rather than the registering jurisdiction |
| source |
S | 1..1 | BackboneElement | Message source application |
| endpoint |
S | 1..1 | url | Actual message source address or id |
| response |
0..0 | Not used on a notification. Acknowledgements use the Fact of Death Acknowledgement Message Header. | ||
| focus |
S | 1..1 | Reference(Fact of Death Death Date) | The Death Date observation that carries the fact of death |
| Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | Whether this message notifies, corrects, or retracts a fact of death Binding: Fact of Death Notification Event Value Set (required) | ||||
| destination |
SΣ | 1..* | 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 |
SΣ | 1..1 | url | Actual destination address or id | ||||
| receiver |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The provider organization the notification is intended for, where known | ||||
| sender |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for sending this message, which may be a relaying intermediary rather than the registering jurisdiction | ||||
| 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 |
SΣ | 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. | ||||
| focus |
SΣ | 1..1 | Reference(Fact of Death Death Date) | The Death Date observation that carries the fact of death | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| 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. |
| 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: 8 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron