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
Version 1.0
Last updated : June 24, 2025
Table of Content
Required Fields for All Linkages
Required Fields for Live Births
Required Fields for Fetal Deaths
The following fields are required for a valid maternal linkage submission. An Error Message will be returned for each missing field.
Field Description | FHIR Profile | FHIR Field |
Decedent Certificate Number | MaternalLinkageContentBundle | identifier.extension[certificateNumber].value |
Record Identifier | MaternalLinkageContentBundle | identifier.value |
Correctness of Pregnancy Status | RecentPregnancyParameters | parameter[preg_status_is_correct].value[X] |
The following fields are required for a valid maternal linkage submission. An Error Message will be returned for each missing field.
Field Description | FHIR Profile | FHIR Field |
Certificate Availability for Birth | BirthRecordIdentifierChild | component[cert_available].value[x] |
The following fields are required for a valid maternal linkage submission. An Error Message will be returned for each missing field.
Field Description | FHIR Profile | FHIR Field |
Certificate Availability for Fetal Death | FetalDeathRecordIdentifier | component[cert_available].value[x] |
The following combinations of field values will also result in an error being returned for a submission. An Error Message with a format of "Error: Invalid combination of Field 1 and Field 2" will be returned for each invalid combination reported.
Field 1 | Field 2 | ||
Description | Value | Description | Value |
Decedent Death Date | Greater than Date of Birth or Fetal Death | Birth or Fetal Death Date | Less than Decedent Death Date |
Birth Plurality or Fetal Death Plurality | 0 | Birth Record Identifier Child or Fetal Death Record Identifier | Not 'Not Provided (1) |
Birth Plurality or Fetal Death Plurality | Greater than or equal to 1 | Birth Record Identifier Child or Fetal Death Record Identifier | Not Provided (2) |
Pregnancy Outcome | Spontaneous Abortion, Induced Abortion, Ectopic Pregnancy, Molar Pregnancy | Birth Record Identifier Child, Fetal Death Record Identifier | Not 'Not Provided (3) |
Pregnancy Outcome | Fetal Death, Live Birth | Birth Record Identifier Child, Fetal Death Record Identifier (4) | Not Provided |
Pregnancy Outcome | Plural Fetal Death and Birth | Birth Record Identifier Child, Fetal Death Record Identifier | Both Not Provided (5) |
Certificate Availability | Yes | Child’s Birth Record Number, Birth Jurisdiction, Birth Year, Index | Not Provided (1) |
The following fields refer to the presence of BirthRecordIdentifier and/or FetalDeathRecordIdentifier instances as part of the MaternalLinkageBundle submission:
If BirthRecordIdentifierChild or FetalDeathRecordIdentifier profile instance is provided and the Certificate Availability value is 'Yes', fields can be considered 'not provided' if:
VROs should resubmit complete data when making updates