Vital Records FHIR Messaging (VRFM) IG
3.0.0-Preview1 - 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 3.0.0-Preview1 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

NCHS FHIR Implementation Notes

NCHS Notes on Production Use of VRDR STU2.2 and VRFM 1.0.1

Version 1.0

Last updated : May 28, 2025

Table of Content

FHIR IGs for Mortality Data Submission to NCHS

VRDR STU2.2 Errata

VRFM 1.0.1 Errata

FHIR IGs for Mortality and Natality Data Submission to NCHS

Current submissions to NCHS used in production are based on the following FHIR IGs:

Periodically, NCHS will transition the submission process to use new published versions of these IGs and new IGs.

Testing events have begun based on the following FHIR IGs:

As with any software product or specification, bugs/issues will be identified between publication events. The purpose of this document is to provide documentation about known bugs/issues/errata in the published specifications that implementers may need to successfully implement FHIR-based death record submission.

The following table summarizes the history of the IGs, correspondance to other resources, and their status.

Implementation Guide Supporting VRFM Version Supporting Software Version Status as of June 2025
VRDR STU2.2.0 VRFM STU1.0.1 VRDR-dotnet 4.x.x Implemented and used in production.
VRDR STU3.0.0 VRFM STU2.0.0 VRDR-dotnet 5.x.x Not implemented for testing or production yet.
BFDR STU2.0.0 VRFM STU2.0.0 BFDR-dotnet 1.x.x Testing events have begun.
VRCL STU2.0.0 VRFM STU2.0.0 VR-dotnet 1.x.x Used to support VRDR STU3.0.0 and BFDR STU2.0.0.

VRDR STU2.2 Errata

  • Handling of STATESP (State Specific field) in Cause of Death Coded Bundle
    • The Cause of Death Coded Bundle is intended to be content equivalent to the Transax (TRX) coded cause of death data definition. in VRDR STU2.2 one field - STATESP - that is sent by jurisdictions to NCHS was left out of the associated bundle. This omission will not be rectified in VRDR STU2, but is included in VRDR STU3. This field is sent by jurisdictions to NCHS, so jurisdictions should be in possession of the data element.
  • Description of State Auxiliary Identifiers (AUXNO1 and AUXNO2)
    • The State Auxiliary Identifiers are fields that are passed by the jurisdiction to NCHS and returned unchanged in the bundles associated with the death certificate. The VRDR STU2.2 documentation describes them as integer-valued fields that are left-prefixed with zeroes. That is inaccurate. These are string fields of fixed length that NCHS stores, and returns, but does not check for format or content. They are for use as the jurisdictions choose to use them. The documentation of these fields is updated in VRDR STU3. NCHS-provided software (e.g., vrdr-dotnet) will treat them as fixed length strings.
  • Use of Inactivated SNOMEDCT Code #103693007 "Diagnostic Procedure"

VRFM 1.0.1 Errata

No errata have been identified.