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

Business Rules for Birth Record Submissions

Business Rules for Birth Record Submissions

Version 0.1

Last updated : August 9, 2024

Table of Content

Required Fields

Additional Checks

Internal Validation Errors

Required Fields

The following fields are required for a valid birth record submission to be processed. An Error Message with a format of "Error: Unable to find IJE Field required element" will be returned for each missing field.

Field Description IJE Field FHIR Profile FHIR Field
State, U.S. Territory or Canadian Province of Death - code BSTATE State, U.S. Territory or Canadian Province of Birth (Infant) - code address.state or address.state.extension[nationalReportingJurisdictionId]

If both are provided, the extension will override. Unless you are NYC, recommend using address.state only.
Certificate Number FILENO BundleDocumentBirthReport identifier.extension[certificateNumber].value
Date of Birth (Infant)--Year IDOB_YR PatientChildVitalRecords birthDate.value
Date of Birth (Infant)--Year IDOB_MO PatientChildVitalRecords birthDate.value
Date of Birth (Infant)--Year IDOB_DY PatientChildVitalRecords birthDate.value

Additional Checks

Records that contain the minimal set of required fields will be processed by NCHS. Reports on the completeness of each record will be shared with jurisdictions through the same channels as is done for IJE-formatted records. This process may be revised to introduce more stringent checking of submissions as NCHS and Jurisdictions gain experience with the process.

Internal Validation Errors

The following error messages are internal validation errors and if you receive any of these, please contact NCHS.

Error Message
An unexpected network error occurred.
Exception has been thrown by the target of an invocation.
Object reference not set to an instance of an object.
The network path was not found.
Unable to find the specified file.