Vital Records FHIR Messaging (VRFM) IG
3.0.0-Preview1 - ci-build

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

Resource Profile: Acknowledgement Header

Official URL: http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/StructureDefinition/VRM-AcknowledgementHeader Version: 3.0.0-Preview1
Draft as of 2025-11-25 Computable Name: AcknowledgementHeader

Acknowledgement Header

The Acknowledgement Message’s MessageHeader.response.identifier must equal the value of the MessageHeader.id property of the message that is being acknowledged. When processing acknowledgements this identifier must be used to associate the acknowledgement with the message that is being acknowledged. This association is the basis for implementing reliable messaging.

The MessageHeader.eventURI should be set as follows:

  • Death: http://nchs.cdc.gov/vrdr_acknowledgement
  • Fetal Death: http://nchs.cdc.gov/fd_acknowledgement
  • Birth: http://nchs.cdc.gov/birth_acknowledgement

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
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... event[x]:eventUri Σ 1..1 uri Code for the event this message represents or link to event definition
Binding: Acknowledgement MessageHeader URI Values (required)
... destination Σ 1..* BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual destination address or id
... source Σ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... focus Σ 1..2 Reference(Message Parameters) The actual content of the message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventUri Base required Acknowledgement MessageHeader URI Values 📦3.0.0-Preview1 This IG

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 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id 1..1 id Logical id of this artifact
... Slices for event[x] 1..1 uri Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
.... event[x]:eventUri 1..1 uri Code for the event this message represents or link to event definition
Binding: Acknowledgement MessageHeader URI Values (required)
... destination 1..* BackboneElement Message destination application(s)
.... identifier 1..1 id The value of the MessageHeader.id for the message that is being acknowledged
.... code 1..1 code ok | transient-error | fatal-error
Fixed Value: ok
... focus 1..2 Reference(Message Parameters) The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MessageHeader.event[x]:eventUri Base required Acknowledgement MessageHeader URI Values 📦3.0.0-Preview1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 1..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
... Slices for event[x] Σ 1..1 uri Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
.... event[x]:eventUri Σ 1..1 uri Code for the event this message represents or link to event definition
Binding: Acknowledgement MessageHeader URI Values (required)
... destination Σ 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 Σ 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 Σ 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 Σ 0..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 Σ 1..1 id The value of the MessageHeader.id for the message that is being acknowledged
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
Fixed Value: ok
.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 1..2 Reference(Message Parameters) The actual content of the message
... 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 example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventUri Base required Acknowledgement MessageHeader URI Values 📦3.0.0-Preview1 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: 4 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.event[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... event[x]:eventUri Σ 1..1 uri Code for the event this message represents or link to event definition
Binding: Acknowledgement MessageHeader URI Values (required)
... destination Σ 1..* BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual destination address or id
... source Σ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... focus Σ 1..2 Reference(Message Parameters) The actual content of the message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventUri Base required Acknowledgement MessageHeader URI Values 📦3.0.0-Preview1 This IG

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 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id 1..1 id Logical id of this artifact
... Slices for event[x] 1..1 uri Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
.... event[x]:eventUri 1..1 uri Code for the event this message represents or link to event definition
Binding: Acknowledgement MessageHeader URI Values (required)
... destination 1..* BackboneElement Message destination application(s)
.... identifier 1..1 id The value of the MessageHeader.id for the message that is being acknowledged
.... code 1..1 code ok | transient-error | fatal-error
Fixed Value: ok
... focus 1..2 Reference(Message Parameters) The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MessageHeader.event[x]:eventUri Base required Acknowledgement MessageHeader URI Values 📦3.0.0-Preview1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 1..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
... Slices for event[x] Σ 1..1 uri Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
.... event[x]:eventUri Σ 1..1 uri Code for the event this message represents or link to event definition
Binding: Acknowledgement MessageHeader URI Values (required)
... destination Σ 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 Σ 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 Σ 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 Σ 0..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 Σ 1..1 id The value of the MessageHeader.id for the message that is being acknowledged
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
Fixed Value: ok
.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 1..2 Reference(Message Parameters) The actual content of the message
... 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 example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventUri Base required Acknowledgement MessageHeader URI Values 📦3.0.0-Preview1 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: 4 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.event[x]

 

Other representations of profile: CSV, Excel, Schematron