Vital Records FHIR Messaging (VRFM) IG
2.0.0-Preview3 - ci-build
Vital Records FHIR Messaging (VRFM) IG
2.0.0-Preview3 - 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-Preview3 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-DemographicsCodingHeader | Version: 2.0.0-Preview3 | |||
| Draft as of 2024-10-23 | Computable Name: DemographicsCodingHeader | |||
Demographics Coding 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 Fixed Value: http://nchs.cdc.gov/vrdr_demographics_coding | |
| destination |
1..* | BackboneElement | Message destination application(s) | |
| response |
||||
| identifier |
1..1 | id | The value of the MessageHeader.id for the Death Record message that is being coded | |
 code |
1..1 | code | ok | transient-error | fatal-error Fixed Value: ok | |
| focus |
1..2 | Reference(Resource) | The actual content of the message | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| 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: MessageEvent (example): One of the message events defined as part of this version of FHIR. Fixed Value: http://nchs.cdc.gov/vrdr_demographics_coding |
 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(Resource) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | |
| MessageHeader.event[x]:eventUri | example | Fixed Value: http://nchs.cdc.gov/vrdr_demographics_codinghttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| 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 | |||||
| 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: MessageEvent (example): One of the message events defined as part of this version of FHIR. Fixed Value: http://nchs.cdc.gov/vrdr_demographics_coding | ||||
| 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 Death Record message that is being coded | ||||
| 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(Resource) | The actual content of the message | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | ||||
| MessageHeader.event[x]:eventUri | example | Fixed Value: http://nchs.cdc.gov/vrdr_demographics_codinghttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounterfrom the FHIR Standard | ||||
| MessageHeader.response.code | required | Fixed Value: okhttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
This structure is derived from MessageHeader
Summary
Mandatory: 4 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 Fixed Value: http://nchs.cdc.gov/vrdr_demographics_coding | |
| destination |
1..* | BackboneElement | Message destination application(s) | |
| response |
||||
| identifier |
1..1 | id | The value of the MessageHeader.id for the Death Record message that is being coded | |
| code |
1..1 | code | ok | transient-error | fatal-error Fixed Value: ok | |
| focus |
1..2 | Reference(Resource) | The actual content of the message | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| 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: MessageEvent (example): One of the message events defined as part of this version of FHIR. Fixed Value: http://nchs.cdc.gov/vrdr_demographics_coding |
| 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(Resource) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | |
| MessageHeader.event[x]:eventUri | example | Fixed Value: http://nchs.cdc.gov/vrdr_demographics_codinghttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| 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 | |||||
| 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: MessageEvent (example): One of the message events defined as part of this version of FHIR. Fixed Value: http://nchs.cdc.gov/vrdr_demographics_coding | ||||
| 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 Death Record message that is being coded | ||||
| 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(Resource) | The actual content of the message | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | ||||
| MessageHeader.event[x]:eventUri | example | Fixed Value: http://nchs.cdc.gov/vrdr_demographics_codinghttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounterfrom the FHIR Standard | ||||
| MessageHeader.response.code | required | Fixed Value: okhttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
This structure is derived from MessageHeader
Summary
Mandatory: 4 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron