Vital Records FHIR Messaging (VRFM) IG
2.0.0 - release

Vital Records FHIR Messaging (VRFM) IG - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Outcome Profile

Official URL: http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/StructureDefinition/VRM-Outcome | Version: 2.0.0
Active as of 2025-08-11 | Computable Name: Outcome

Outcome profile to support profile-based slicing of bundles

Usages:

- Use this Profile: Acknowledgement Message and Extraction Error Message
- Refer to this Profile: Extraction Error Header
- Examples for this Profile: OperationOutcome/Outcome-Example1 and OperationOutcome/Outcome-Example2

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
--- | --- | --- | --- | ---
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 | Σ | 1..* | BackboneElement | A single issue associated with the action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
severity | Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code | Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
OperationOutcome.issue.severity | required | IssueSeverity `http://hl7.org/fhir/ValueSet/issue-severity|4.0.1` From the FHIR Standard
OperationOutcome.issue.code | required | IssueType `http://hl7.org/fhir/ValueSet/issue-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
OperationOutcome |  | 0..* | OperationOutcome | Information about the success/failure of an action
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | Σ | 1..* | BackboneElement | A single issue associated with the action
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 | Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code | Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details | Σ | 0..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
OperationOutcome.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
OperationOutcome.issue.severity | required | IssueSeverity `http://hl7.org/fhir/ValueSet/issue-severity|4.0.1` From the FHIR Standard
OperationOutcome.issue.code | required | IssueType `http://hl7.org/fhir/ValueSet/issue-type|4.0.1` From the FHIR Standard
OperationOutcome.issue.details | example | OperationOutcomeCodes `http://hl7.org/fhir/ValueSet/operation-outcome` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 | Σ | 1..* | BackboneElement | A single issue associated with the action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
severity | Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code | Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
OperationOutcome.issue.severity | required | IssueSeverity `http://hl7.org/fhir/ValueSet/issue-severity|4.0.1` From the FHIR Standard
OperationOutcome.issue.code | required | IssueType `http://hl7.org/fhir/ValueSet/issue-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
OperationOutcome |  | 0..* | OperationOutcome | Information about the success/failure of an action
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | Σ | 1..* | BackboneElement | A single issue associated with the action
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 | Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code | Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details | Σ | 0..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
OperationOutcome.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
OperationOutcome.issue.severity | required | IssueSeverity `http://hl7.org/fhir/ValueSet/issue-severity|4.0.1` From the FHIR Standard
OperationOutcome.issue.code | required | IssueType `http://hl7.org/fhir/ValueSet/issue-type|4.0.1` From the FHIR Standard
OperationOutcome.issue.details | example | OperationOutcomeCodes `http://hl7.org/fhir/ValueSet/operation-outcome` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Other representations of profile: CSV, Excel, Schematron