Vital Records FHIR Messaging (VRFM) IG
2.0.0-Preview5 - ci-build
Vital Records FHIR Messaging (VRFM) IG, published by CDC NCHS. This guide is not an authorized publication; it is the continuous build for version 2.0.0-Preview5 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nightingaleproject/vital_records_fhir_messaging_ig/ and changes regularly. See the Directory of published versions
Official URL: http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/StructureDefinition/VRM-DemographicsCodingUpdateHeader | Version: 2.0.0-Preview5 | |||
Draft as of 2025-04-23 | Computable Name: DemographicsCodingUpdateHeader |
Demographics Coding Update Header
The MessageHeader.response.identifier must equal the value of the MessageHeader.id property of the message that was coded. When processing coding responses this identifier must be used to associate the coding content with the message that was coded. This association ensures clarity when a death record is submitted or updated multiple times, and coding responses are delivered for a subset of these submissions.
The MessageHeader.eventURI should be set as follows:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: Demographics Coding Update MessageHeader URI Values (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Message destination application(s) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual message source address or id ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..2 | Reference(Resource) | The actual content of the message ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | |
MessageHeader.event[x]:eventUri | required | DemographicsCodingUpdateHeaderURIVShttp://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-DemographicsCodingUpdateHeaderURI-vs from this IG |
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
![]() ![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() ![]() |
1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | uri | Code for the event this message represents or link to event definition Binding: Demographics Coding Update MessageHeader URI Values (required) | |
![]() ![]() ![]() |
1..* | BackboneElement | Message destination application(s) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | id | The value of the MessageHeader.id for the Death Record message that is being coded | |
![]() ![]() ![]() ![]() |
1..1 | code | ok | transient-error | fatal-error Fixed Value: ok | |
![]() ![]() ![]() |
1..2 | Reference(Resource) | The actual content of the message | |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x]:eventUri | required | DemographicsCodingUpdateHeaderURIVShttp://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-DemographicsCodingUpdateHeaderURI-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: Demographics Coding Update MessageHeader URI Values (required) | ||||
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Message destination application(s) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of software running the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of software running | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual message source address or id | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | id | The value of the MessageHeader.id for the Death Record message that is being coded | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. Fixed Value: ok | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() |
Σ | 1..2 | Reference(Resource) | The actual content of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | ||||
MessageHeader.event[x]:eventUri | required | DemographicsCodingUpdateHeaderURIVShttp://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-DemographicsCodingUpdateHeaderURI-vs from this IG | ||||
MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard | ||||
MessageHeader.response.code | required | Fixed Value: okhttp://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard |
This structure is derived from MessageHeader
Summary
Mandatory: 4 elements
Fixed: 1 element
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: Demographics Coding Update MessageHeader URI Values (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Message destination application(s) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual message source address or id ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..2 | Reference(Resource) | The actual content of the message ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | |
MessageHeader.event[x]:eventUri | required | DemographicsCodingUpdateHeaderURIVShttp://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-DemographicsCodingUpdateHeaderURI-vs from this IG |
Differential View
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
![]() ![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() ![]() |
1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | uri | Code for the event this message represents or link to event definition Binding: Demographics Coding Update MessageHeader URI Values (required) | |
![]() ![]() ![]() |
1..* | BackboneElement | Message destination application(s) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | id | The value of the MessageHeader.id for the Death Record message that is being coded | |
![]() ![]() ![]() ![]() |
1..1 | code | ok | transient-error | fatal-error Fixed Value: ok | |
![]() ![]() ![]() |
1..2 | Reference(Resource) | The actual content of the message | |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x]:eventUri | required | DemographicsCodingUpdateHeaderURIVShttp://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-DemographicsCodingUpdateHeaderURI-vs from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: Demographics Coding Update MessageHeader URI Values (required) | ||||
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Message destination application(s) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of software running the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of software running | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual message source address or id | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | id | The value of the MessageHeader.id for the Death Record message that is being coded | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. Fixed Value: ok | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() |
Σ | 1..2 | Reference(Resource) | The actual content of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | ||||
MessageHeader.event[x]:eventUri | required | DemographicsCodingUpdateHeaderURIVShttp://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-DemographicsCodingUpdateHeaderURI-vs from this IG | ||||
MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard | ||||
MessageHeader.response.code | required | Fixed Value: okhttp://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard |
This structure is derived from MessageHeader
Summary
Mandatory: 4 elements
Fixed: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron