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 Match Outcome

Official URL: http://example.org/fhir/us/fod/StructureDefinition/fod-match-outcome Version: 0.2.0
Standards status: Informative Maturity Level: 1 Computable Name: FODMatchOutcome

The outcome a receiving system reports for a fact-of-death notification: whether it matched a patient record, found none, found several, or deferred the decision to a human. This is the feedback that lets a jurisdiction tell whether its notifications are actually landing, without disclosing anything about the matched patient.

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
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... issue SΣ 1..1 BackboneElement Exactly one issue, carrying the match outcome
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... severity SΣ 1..1 code information for a successful match, warning where the notification could not be applied
Binding: IssueSeverity (required): How the issue affects the success of the action.
.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.
.... details SΣ 1..1 CodeableConcept The match outcome
Binding: Fact of Death Match Outcome Value Set (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationOutcome.issue.​severity Base required IssueSeverity 📍4.0.1 FHIR Std.
OperationOutcome.issue.​code Base required IssueType 📍4.0.1 FHIR Std.
OperationOutcome.issue.​details Base required Fact of Death Match Outcome Value Set 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error OperationOutcome If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error OperationOutcome 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 OperationOutcome 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 OperationOutcome If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice OperationOutcome 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 OperationOutcome

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome OperationOutcome
... issue S 1..1 BackboneElement Exactly one issue, carrying the match outcome
.... severity S 1..1 code information for a successful match, warning where the notification could not be applied
.... code S 1..1 code Error or warning code
.... details S 1..1 CodeableConcept The match outcome
Binding: Fact of Death Match Outcome Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
OperationOutcome.issue.​details Base required Fact of Death Match Outcome Value Set 📦0.2.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... 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
... issue SΣ 1..1 BackboneElement Exactly one issue, carrying the match outcome
.... 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
.... severity SΣ 1..1 code information for a successful match, warning where the notification could not be applied
Binding: IssueSeverity (required): How the issue affects the success of the action.
.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.
.... details SΣ 1..1 CodeableConcept The match outcome
Binding: Fact of Death Match Outcome Value Set (required)
.... diagnostics Σ 0..1 string Additional diagnostic information about the issue
.... location Σ 0..* string Deprecated: Path of element(s) related to issue
.... expression Σ 0..* string FHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationOutcome.language Base preferred Common Languages 📍4.0.1 FHIR Std.
OperationOutcome.issue.​severity Base required IssueSeverity 📍4.0.1 FHIR Std.
OperationOutcome.issue.​code Base required IssueType 📍4.0.1 FHIR Std.
OperationOutcome.issue.​details Base required Fact of Death Match Outcome Value Set 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error OperationOutcome If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error OperationOutcome 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 OperationOutcome 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 OperationOutcome If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice OperationOutcome 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 OperationOutcome

Summary

Mandatory: 2 elements
Must-Support: 4 elements

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... issue SΣ 1..1 BackboneElement Exactly one issue, carrying the match outcome
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... severity SΣ 1..1 code information for a successful match, warning where the notification could not be applied
Binding: IssueSeverity (required): How the issue affects the success of the action.
.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.
.... details SΣ 1..1 CodeableConcept The match outcome
Binding: Fact of Death Match Outcome Value Set (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationOutcome.issue.​severity Base required IssueSeverity 📍4.0.1 FHIR Std.
OperationOutcome.issue.​code Base required IssueType 📍4.0.1 FHIR Std.
OperationOutcome.issue.​details Base required Fact of Death Match Outcome Value Set 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error OperationOutcome If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error OperationOutcome 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 OperationOutcome 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 OperationOutcome If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice OperationOutcome 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 OperationOutcome

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome OperationOutcome
... issue S 1..1 BackboneElement Exactly one issue, carrying the match outcome
.... severity S 1..1 code information for a successful match, warning where the notification could not be applied
.... code S 1..1 code Error or warning code
.... details S 1..1 CodeableConcept The match outcome
Binding: Fact of Death Match Outcome Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
OperationOutcome.issue.​details Base required Fact of Death Match Outcome Value Set 📦0.2.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... 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
... issue SΣ 1..1 BackboneElement Exactly one issue, carrying the match outcome
.... 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
.... severity SΣ 1..1 code information for a successful match, warning where the notification could not be applied
Binding: IssueSeverity (required): How the issue affects the success of the action.
.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.
.... details SΣ 1..1 CodeableConcept The match outcome
Binding: Fact of Death Match Outcome Value Set (required)
.... diagnostics Σ 0..1 string Additional diagnostic information about the issue
.... location Σ 0..* string Deprecated: Path of element(s) related to issue
.... expression Σ 0..* string FHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationOutcome.language Base preferred Common Languages 📍4.0.1 FHIR Std.
OperationOutcome.issue.​severity Base required IssueSeverity 📍4.0.1 FHIR Std.
OperationOutcome.issue.​code Base required IssueType 📍4.0.1 FHIR Std.
OperationOutcome.issue.​details Base required Fact of Death Match Outcome Value Set 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error OperationOutcome If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error OperationOutcome 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 OperationOutcome 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 OperationOutcome If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice OperationOutcome 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 OperationOutcome

Summary

Mandatory: 2 elements
Must-Support: 4 elements

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron